This module is used when using the filesystem and manipulating files.
This module provides a set of cross-platform methods to manipulate the filesystem the application is sitting on. If at all possible, avoid using the remove_dir_all function.
Structs, Traits, and Enums
- Structs: DirBuilder (used to create directories), DirEntry (returned by the ReadDir iterator), File (opens a file on the filesystem), FileType (represents a type of file with accessors to each file type), Metadata (information about the file), OpenOptions (options and flags used to configure how a file is opened), Permissions (file permissions on a file), and ReadDir (an iterator over the entries in a directory).
- Functions: canonicalize (returns the canonical form of a path), copy (copies files), create_dir, create_dir_all (recursively creates a directory and all parent components if missing), hard_link (creates a hard link on the file system), metadata (gets the metadata for a given path and file), read_dir (returns an iterator over the entries within a directory), read_link (reads a symbolic link returning the file it points to), remove_dir (removes an empty directory), remove_dir_all (removes a directory on a path recursively—on some operating systems this can completely delete your hard drive, so be careful!), remove_file (deletes a file), rename (renames a given file or directory), set_permissions (sets permissions on a given file or directory), and symlink_metadata (queries the metadata for a file without following any symlinks).