Bifrost SDK
Bifrost SDK documentation
Bifrost::FileUtils Namespace Reference

Functions

bool isAbsolute (Amino::StringView path)
 Checks if a path is absolute. More...
 
bool createDirectories (Amino::StringView path, Amino::String *errorMessage=nullptr)
 Creates the directories in path that do not exist. More...
 
bool currentPath (Amino::String &currentPath, Amino::String *errorMessage=nullptr)
 Returns the current path. More...
 
Amino::String extractParentPath (Amino::StringView path)
 Returns the parent path of path. The input is first processed by makePreferred. Then the extraction follows C++17 std::filesystem. More...
 
Amino::String makePreferred (Amino::StringView path)
 Convert directory separator characters in the given string to the operating system's preferred character. (For unix systems this is a forward slash, and for Windows, a backslash) More...
 
Amino::String filePath (Amino::StringView directory, Amino::StringView filename)
 Create a file path from a directory and an filename in an operating system / independent way. More...
 
Amino::String filename (Amino::StringView baseName, long long frame, Amino::StringView targetExtension)
 Construct a file name with the specified frame number and extension. If the file name contains # or @ they will be replaced with the given frame number. # will reserve 4 digits for the frame number, whereas @ will reserve just one. If a target file extension is specified it will be enforced, otherwise will be ignored. More...
 
Amino::String extractFilename (Amino::StringView filePath)
 Get the filename (with extension) from a file path. The input is first processed by makePreferred. Then the extraction follows C++17 std::filesystem. More...
 
bool filePathExists (Amino::StringView filePath, Amino::String *out_errorMessage=nullptr)
 Verify if a file path exists. More...
 
Amino::String getRelativePath (Amino::StringView path, Amino::StringView baseDirectory)
 Return the valid relative path of the input path with respect to baseDirectory. More...
 
bool exists (Amino::StringView path, Amino::String *errorMessage=nullptr)
 Verify if a path exists. More...
 
bool tempDirectoryPath (Amino::String &tempDirectoryPath, Amino::String *errorMessage=nullptr)
 Returns the directory location suitable for temporary files. More...
 
bool removeAll (Amino::StringView path, Amino::String *errorMessage=nullptr)