Apache Mesos
rename.hpp
Go to the documentation of this file.
1 // Licensed under the Apache License, Version 2.0 (the "License");
2 // you may not use this file except in compliance with the License.
3 // You may obtain a copy of the License at
4 //
5 // http://www.apache.org/licenses/LICENSE-2.0
6 //
7 // Unless required by applicable law or agreed to in writing, software
8 // distributed under the License is distributed on an "AS IS" BASIS,
9 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
10 // See the License for the specific language governing permissions and
11 // limitations under the License.
12 
13 #ifndef __STOUT_OS_WINDOWS_RENAME_HPP__
14 #define __STOUT_OS_WINDOWS_RENAME_HPP__
15 
16 #include <string>
17 
18 #include <stout/error.hpp>
19 #include <stout/nothing.hpp>
20 #include <stout/try.hpp>
21 #include <stout/windows.hpp>
22 
24 
25 
26 namespace os {
27 
28 inline Try<Nothing> rename(const std::string& from, const std::string& to)
29 {
30  // Use `MoveFile` to perform the file move. The MSVCRT implementation of
31  // `::rename` fails if the `to` file already exists[1], while some UNIX
32  // implementations allow that[2].
33  //
34  // Use `MOVEFILE_COPY_ALLOWED` to allow moving the file to another volume and
35  // `MOVEFILE_REPLACE_EXISTING` to comply with the UNIX implementation and
36  // replace an existing file[3].
37  //
38  // [1] https://msdn.microsoft.com/en-us/library/zw5t957f.aspx
39  // [2] http://man7.org/linux/man-pages/man2/rename.2.html
40  // [3] https://msdn.microsoft.com/en-us/library/windows/desktop/aa365240(v=vs.85).aspx
41  const BOOL result = ::MoveFileExW(
42  ::internal::windows::longpath(from).data(),
43  ::internal::windows::longpath(to).data(),
44  MOVEFILE_COPY_ALLOWED | MOVEFILE_REPLACE_EXISTING);
45 
46  if (!result) {
47  return WindowsError(
48  "`os::rename` failed to move file '" + from + "' to '" + to + "'");
49  }
50 
51  return Nothing();
52 }
53 
54 } // namespace os {
55 
56 #endif // __STOUT_OS_WINDOWS_RENAME_HPP__
Definition: nothing.hpp:16
Definition: check.hpp:33
Definition: error.hpp:108
Definition: posix_signalhandler.hpp:23
Try< Nothing > rename(const std::string &from, const std::string &to)
Definition: rename.hpp:27
std::wstring longpath(const std::string &path)
Definition: longpath.hpp:38