Skip to content

Rose::FileSystem

Functions for operating on files in a filesystem.

Types

Name Description
baseNameMatches Predicate returning true for matching names.

Type Aliases

Name Description
DirectoryIterator Iterate over directory contents non-recursively.
Path Name of entities in a filesystem.
RecursiveDirectoryIterator Iterate recursively into subdirectories.

Functions

Name Description
copyFile
[[visibility("default")]] void copyFile( Path const& sourceFileName, Path const& destinationFileName);
Copy a file.
copyFiles
[[visibility("default")]] void copyFiles( std::vector<Path> const& files, Path const& root, Path const& destinationDirectory);
Copy files from one directory to another.
copyFilesRecursively
template< class Select, class Descend> void copyFilesRecursively( Path const& root, Path const& destination, Select select, Descend descend);
Recursively copy files.
createTemporaryDirectory
[[visibility("default")]] Path createTemporaryDirectory();
Create a temporary directory.
findNames
[[visibility("default")]] std::vector<Path> findNames(Path const& root);
Entries within a directory.
findNamesRecursively
[[visibility("default")]] std::vector<Path> findNamesRecursively(Path const& root);
Recursive list of names satisfying predicate.
findRoseFilesRecursively
[[visibility("default")]] std::vector<Path> findRoseFilesRecursively(Path const& root);
Return a list of all rose_* files
isDirectory
[[visibility("default")]] bool isDirectory(Path const& path);
Predicate returning true for existing directories.
isExisting
[[visibility("default")]] bool isExisting(Path const& path);
Predicate returning true if path exists.
isFile
[[visibility("default")]] bool isFile(Path const& path);
Predicate returning true for existing regular files.
isNotSymbolicLink
[[visibility("default")]] bool isNotSymbolicLink(Path const& path);
Predicate returning inverse of isSymbolicLink.
isSymbolicLink
[[visibility("default")]] bool isSymbolicLink(Path const& path);
Predicate returning true for existing symbolic links.
makeAbsolute
[[visibility("default")]] Path makeAbsolute( Path const& path, Path const& root = std::filesystem::current_path());
Make path absolute.
makeNormal
[[visibility("default")]] Path makeNormal(Path const&);
Normalize a path name.
makeRelative
[[visibility("default")]] Path makeRelative( Path const& path, Path const& root = std::filesystem::current_path());
Make path relative.
readFile
template<class Container> Container readFile( std::filesystem::path const& fileName, std::ios_base::openmode openMode = std::ios_base::in | std::ios_base::binary);
Load an entire file into an STL container.
toString
[[visibility("default")]] std::string toString(Path const& path);
Convert a path to a string.
writeFile
template<class Container> void writeFile( std::filesystem::path const& fileName, Container const& data, std::ios_base::openmode openMode = std::ios_base::out | std::ios_base::binary);
Write a container to a file.

Created with MrDocs