Filesystem path and open‐flag helpers.
Types
Name |
Description |
RAII lock holding an exclusive lock on an open file. |
|
Represents a temporary file. |
|
Stable identifier for a filesystem object, composed of device and inode. |
|
Subset of file status available from directory iteration. |
|
directory_entry ‐ A single entry in a directory. |
|
Iterates through the entries in a directory. |
|
Represents the result of a call to sys::fs::status(). |
|
This class represents a memory mapped file. It is based on boost::iostreams::mapped_file. |
|
recursive_directory_iterator ‐ Same as directory_iterator except for it recurses down into child directories. |
|
Disk capacity and free‐space statistics for a filesystem. |
Type Aliases
Name |
Description |
Native file handle type for the host platform. |
Enums
Name |
Description |
Default chunk size for readNativeFileToEOF(). |
|
Access check requested by |
|
Flags controlling whether an existing file is truncated or created. |
|
Access mode flags for opening a file. |
|
An enumeration for the lock kind. |
|
Flags controlling how a file is opened for writing. |
|
An enumeration for the file system's view of the type. |
|
POSIX‐style permission bits for filesystem objects. |
Functions
Name |
Description |
Can the file be accessed? |
|
Can we execute this file? |
|
Can we write this file? |
|
Change ownership of a file. |
|
Close the file object. |
|
Converts from a Posix file descriptor number to a native file handle. |
|
Copy the contents of From to To. |
|
|
|
Create a unique directory whose name starts with |
|
|
|
Create a potentially unique file name but does not create it. |
|
Create all the non‐existent directories in path. |
|
Create the directory in path. |
|
Create a hard link from from to to, or return an error. |
|
Create a link from from to to. |
|
Create a symbolic link from from to to. |
|
Get the current path. |
|
Get disk space usage information. |
|
|
|
Does file exist? |
|
Expands ~ expressions to the user's home directory. On Unix ~user directories are resolved as well. |
|
Get file size. |
|
Return the path to the main executable. |
|
Get file permissions. |
|
Get a unique name, not currently exisiting in the filesystem. Subject to race conditions, prefer to use createUniqueFile instead. |
|
Get a unique temporary file name, not currently exisiting in the filesystem. Subject to race conditions, prefer to use createTemporaryFile instead. |
|
Return an open handle to standard error. On Unix, this is typically FD 2. Returns kInvalidFile when the stream is closed. |
|
Return an open handle to standard in. On Unix, this is typically FD 0. Returns kInvalidFile when the stream is closed. |
|
Return an open handle to standard out. On Unix, this is typically FD 1. Returns kInvalidFile when the stream is closed. |
|
Get file creation mode mask of the process. |
|
Fill |
|
Does status represent a directory? |
|
|
|
|
|
|
|
|
|
|
|
Lock the file. |
|
Make path an absolute path. |
|
|
|
Opens a file with the specified creation disposition, access mode, and flags and returns a file descriptor. |
|
Opens the file with the given name in a read‐only mode, returning its open file descriptor. |
|
Opens the file for read‐write, creating it if it does not exist. |
|
Opens the file for write, creating it if it does not exist. |
|
Opens a file with the specified creation disposition, access mode, and flags and returns a platform‐specific file object. |
|
Opens the file with the given name in a read‐only mode, returning its open file descriptor. |
|
Opens the file for read‐write, creating it if it does not exist. |
|
Opens the file for write, creating it if it does not exist. |
|
Bitwise AND of permission bitmasks |
|
AND‐assign permission bits from |
|
Bitwise disjunction operators |
|
Bitwise disjunction assignment operators |
|
Bitwise complement of permission mask |
|
Read bytes from a native file handle into a buffer. |
|
Read bytes from a native file handle at a given offset. |
|
Reads from |
|
Read the target of a symbolic link. |
|
Collapse all . and .. patterns, resolve all symlinks, and optionally expand ~ expressions to the user's home directory. |
|
Remove path. Equivalent to POSIX remove(). |
|
Recursively delete a directory. |
|
Rename from to to. |
|
Resize path to size. File is resized as if by POSIX truncate(). |
|
|
Resize a file before mapping it read‐write. |
Resize a file with sparse files explicitly enabled. |
|
|
|
|
|
Set the current path. |
|
|
|
Is status available? |
|
Try to locks the file during the specified time. |
|
Unlock the file. |
Variables
Name |
Description |
Sentinel value representing an invalid file handle. |
Created with MrDocs