All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
atomicRenameUtil.h
1 //
2 // Copyright 2017 Pixar
3 //
4 // Licensed under the Apache License, Version 2.0 (the "Apache License")
5 // with the following modification; you may not use this file except in
6 // compliance with the Apache License and the following modification to it:
7 // Section 6. Trademarks. is deleted and replaced with:
8 //
9 // 6. Trademarks. This License does not grant permission to use the trade
10 // names, trademarks, service marks, or product names of the Licensor
11 // and its affiliates, except as required to comply with Section 4(c) of
12 // the License and to reproduce the content of the NOTICE file.
13 //
14 // You may obtain a copy of the Apache License at
15 //
16 // http://www.apache.org/licenses/LICENSE-2.0
17 //
18 // Unless required by applicable law or agreed to in writing, software
19 // distributed under the Apache License with the above modification is
20 // distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
21 // KIND, either express or implied. See the Apache License for the specific
22 // language governing permissions and limitations under the Apache License.
23 //
24 #include "pxr/pxr.h"
25 
26 #include <string>
27 
28 PXR_NAMESPACE_OPEN_SCOPE
29 
30 // Atomically rename \p srcFileName over \p dstFileName, assuming they are
31 // sibling files on the same filesystem. Set \p error and return false in case
32 // of an error, otherwise return true.
33 bool
34 Tf_AtomicRenameFileOver(std::string const &srcFileName,
35  std::string const &dstFileName,
36  std::string *error);
37 
38 // Attempt to create a temporary sibling file of \p fileName. If succesful
39 // return the realpath of \p fileName in \p realFileName, the created temporary
40 // file name in \p tempFileName, and its open file descriptor. In case of an
41 // error, set \p error and return -1.
42 int
43 Tf_CreateSiblingTempFile(std::string fileName,
44  std::string *realFileName,
45  std::string *tempFileName,
46  std::string *error);
47 
48 PXR_NAMESPACE_CLOSE_SCOPE