1 /* 2 * Copyright 2019 Google LLC 3 * 4 * Licensed under the Apache License, Version 2.0 (the "License"); 5 * you may not use this file except in compliance with the License. 6 * You may obtain a copy of the License at 7 * 8 * http://www.apache.org/licenses/LICENSE-2.0 9 * 10 * Unless required by applicable law or agreed to in writing, software 11 * distributed under the License is distributed on an "AS IS" BASIS, 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 * See the License for the specific language governing permissions and 14 * limitations under the License. 15 */ 16 #ifndef FCP_CLIENT_FILES_H_ 17 #define FCP_CLIENT_FILES_H_ 18 19 #include <string> 20 21 #include "absl/status/statusor.h" 22 23 namespace fcp { 24 namespace client { 25 26 // An interface used by the plan engine for platform-dependent file system 27 // access. 28 class Files { 29 public: 30 virtual ~Files() = default; 31 32 // Creates a temporary file. The runtime environment (e.g. operating system) 33 // is expected to clean up these files if necessary, i.e. the engine is not 34 // responsible for their deletion (but may chose to do so). 35 // On success, returns a file path. 36 // On error, returns 37 // - INTERNAL - unexpected error. 38 // - INVALID_ARGUMENT - on "expected" errors such as I/O issues. 39 virtual absl::StatusOr<std::string> CreateTempFile( 40 const std::string& prefix, const std::string& suffix) = 0; 41 }; 42 43 } // namespace client 44 } // namespace fcp 45 46 #endif // FCP_CLIENT_FILES_H_ 47