Module fs

Filesystem utilities.

Structs

AccessModes

Access modes for use with [DirExt::access].

DirBuilder

A builder used to create directories in various manners.

DirEntry

Entries returned by the ReadDir iterator.

DirOptions

Options and flags which can be used to configure how a directory is created.

FileType

A structure representing a type of file with accessors for each file type.

Metadata

Metadata information about a file.

OpenOptions

Options and flags which can be used to configure how a file is opened.

Permissions

Representation of the various permissions on a file.

ReadDir

Iterator over the entries in a directory.

Enums

AccessType

Access modes for use with [DirExt::access].

FollowSymlinks

Should symlinks be followed in the last component of a path?

SystemTimeSpec

A value for specifying a time.

Traits

DirBuilderExt

Unix-specific extensions to [fs::DirBuilder].

FileExt

Unix-specific extensions to [fs::File].

FileTypeExt

Unix-specific extensions for FileType.

MetadataExt

Unix-specific extensions for MetadataExt.

OpenOptionsExt

Unix-specific extensions to [fs::OpenOptions].

PermissionsExt

Unix-specific extensions to Permissions.

Functions

access

Canonicalize the given path, ensuring that the resolution of the path never escapes the directory tree rooted at start.

canonicalize

Canonicalize the given path, ensuring that the resolution of the path never escapes the directory tree rooted at start.

copy

Copies the contents of one file to another.

create_dir

Perform a mkdirat-like operation, ensuring that the resolution of the path never escapes the directory tree rooted at start.

hard_link

Perform a linkat-like operation, ensuring that the resolution of the path never escapes the directory tree rooted at start.

is_file_read_write

Return a pair of booleans indicating whether the given file is opened for reading and writing, respectively.

open

Perform an openat-like operation, ensuring that the resolution of the path never escapes the directory tree rooted at start.

open_ambient

Open a file named by a bare path, using the host process’ ambient authority.

open_ambient_dir

Open a directory named by a bare path, using the host process’ ambient authority.

open_dir

Open a directory by performing an openat-like operation, ensuring that the resolution of the path never escapes the directory tree rooted at start.

open_dir_nofollow

Similar to open_dir, but fails if the path names a symlink.

open_parent_dir

Open the parent directory of a given open directory, using the host process’ ambient authority.

read_base_dir

Like read_dir but operates on the base directory itself, rather than on a path based on it.

read_dir

Construct a ReadDir to iterate over the contents of a directory, ensuring that the resolution of the path never escapes the directory tree rooted at start.

read_link

Perform a readlinkat-like operation, ensuring that the resolution of the path never escapes the directory tree rooted at start, and also verifies that the link target is not absolute.

read_link_contents

Perform a readlinkat-like operation, ensuring that the resolution of the link path never escapes the directory tree rooted at start.

remove_dir

Perform a rmdirat-like operation, ensuring that the resolution of the path never escapes the directory tree rooted at start.

remove_dir_all

Removes a directory and all of its contents.

remove_file

Perform a remove_fileat-like operation, ensuring that the resolution of the path never escapes the directory tree rooted at start.

remove_open_dir

Given an open directory handle, delete the directory.

remove_open_dir_all

Given an open directory handle, recursively delete the contents of the directory plus the directory itself.

rename

Perform a renameat-like operation, ensuring that the resolution of both the old and new paths never escape the directory tree rooted at their respective starts.

reopen

Re-open an fs::File to produce an independent handle.

set_permissions

Perform a chmodat-like operation, ensuring that the resolution of the path never escapes the directory tree rooted at start.

set_symlink_permissions

Perform a chmodat-like operation, ensuring that the resolution of the path never escapes the directory tree rooted at start, without following symlinks.

set_times

Perform a utimensat-like operation, ensuring that the resolution of the path never escapes the directory tree rooted at start. This function follows symlinks.

set_times_nofollow

Like set_times, but never follows symlinks.

stat

Perform an fstatat-like operation, ensuring that the resolution of the path never escapes the directory tree rooted at start.

symlink

Perform a symlinkat-like operation, ensuring that the resolution of the path never escapes the directory tree rooted at start. An error is returned if the target path is absolute.

symlink_contents

Perform a symlinkat-like operation, ensuring that the resolution of the link path never escapes the directory tree rooted at start.