File System

cat~filesystem

This chapters deals with files and file systems.

For most common file system tasks, std::fs↗ and std::path↗ will be sufficient. fs_extra↗ is useful for more advanced operations. tempfile↗ is great for working with temporary files. glob↗ simplifies file pattern matching. Use notify↗ for file watching.

TopicRust Crates or Modules
File I/Ostd::fs↗ in the Standard Library provides the core functionality for working with files and directories (opening, reading, writing, creating, deleting, etc.).
Pathsstd::path↗ provides types and functions for working with file paths (Path↗, PathBuf↗), extracting file names, extensions, and other path components.
Directoriesstd::fs↗ includes functions for creating, listing, and traversing directories.
File Metadatastd::fs↗ allows retrieving information about files (size, modification time, permissions, etc.).
File System Operationsfs_extra↗ provides additional file system operations, such as copying directories recursively, setting file permissions, etc.
Temporary Files and Directoriestempfile↗ creates temporary files and directories.
Globbing (Matching File Patterns)glob↗ matches file paths using 'glob' patterns.
Symbolic Linksstd::fs↗ supports working with symbolic links (though this is platform-dependent).
File Watchingnotify↗ watches files and directories for changes.

Paths

RecipeCratesCategories
Canonicalize a Pathstdcat~filesystem
Ensure your Paths are UTF-8 with caminocat~filesystem
Create and Manipulate Pathscat~filesystem

Reading and Writing Files

RecipeCratesCategories
Read from and Write to a Filestdcat~filesystem
Avoid Writing and Reading from the Same Filesame-filecat~filesystem
Access a File Randomly Using a Memory Mapmemmap2cat~filesystem

Working with the Standard Input and Output

RecipeCratesCategories
Read from the Standard Input and Write to the Standard Output or Standard Errorstdcat~filesystem
RecipeCratesCategories
Work with Symbolic Linksstdcat~filesystem

File Metadata

RecipeCratesCategories
Display File Metadatastdcat~filesystem

Directories

RecipeCratesCategories
Get the Current Working Directorystdcat~filesystem
Create, List Contents of, and Remove Directoriesstdcat~filesystem
Remove a Directory and its Contents with remove_dir_allremove_dir_allcat~filesystem

Directory Traversal

RecipeCratesCategories
Find Files Modified in the Last 24 Hoursstdcat~filesystem cat~os
Find Loops in a Given Pathsame-filecat~filesystem
Recursively Find Duplicate File Nameswalkdircat~filesystem
Recursively Find All Files with a Given Predicatewalkdircat~filesystem
Traverse Directories While Skipping Dotfileswalkdircat~filesystem
Walk the Filesystem While Respecting Ignore Filesignorecat~filesystem
Recursively Calculate File Sizes at a Given Depthwalkdircat~filesystem
Find All Files with a Given Extension Recursivelyglobcat~filesystem
Find All Files with Given Pattern, Ignoring Filename Caseglobcat~filesystem
globsetglobsetcat~filesystem

User Directories and Preferred Applications

RecipeCratesCategories
Locate User Directories with dirsdirscat~filesystem
Locate User Directories with directoriesdirectoriescat~filesystem
Open a File or URL using the Program Configured on your Systemopencat~filesystem

Temporary Files and Directories

RecipeCratesCategories
Create Temporary Files or Temporary Directoriestempfilecat~filesystem

Globbing

FIXME.

File Watching

RecipeCratesCategories
Watch Files or Directories and Execute a Function When They Changenotifycat~filesystem
TopicRust Crates or Modules
Serialization/Deserializationserde↗ is often used with file I/O to read and write structured data (JSON, YAML, TOML, etc.) to files.
Compression/Decompressionflate2↗, gzip↗, bzip2↗, xz2↗ work with various file compression formats.
Archive Filestar↗, zip↗ can be used for working with tar and zip archives.