Module file 

Available on Linux only.

Types for interacting with files (or file-like inodes) on a file system. Primarily revolves around the File type and accompanying access mode markers.

This module provides the File type and various associated types, including markers, errors and builders.

Opening

Although some convenience methods are provided on File itself, the full open functionality is available via the OpenOptions builder (obtainable via File::options).

Files can be opened from an absolute path (Path<Abs>), relative path and directory (Path<Rel>, Directory) or a directory entry (DirEntry).

Closing

Files, despite not visibly implementing Drop, ensure that the associated file is closed when they are dropped, and can panic if an error occurs. To close a file with error handling, the close method can be used instead.

It is also important to note that due to Linux file system behavior, closing a file does not guarantee that it’s data is written to disk. If this is important, please ensure that sync is called before closing.

Access Mode

Each file is associated with an AccessMode, which takes the form of a generic type parameter. There are three available modes: ReadOnly, WriteOnly and ReadWrite, representing those exposed by the Linux syscalls. Wherever applicable, the default mode is ReadWrite. Along with these types, there are also two traits seen in the public API, Read and Write. It is unlikely that these type need to be used directly, but instead act as markers for the available modes to allow overlapping implications.

Structs

File

An open file, allowing for reading and writing according to the associated AccessMode. The underlying file is guaranteed to exist for the lifetime of the File.

OpenOptions

A builder struct to help with opening files, using customizable options and logical defaults. Available via File::options to avoid additional use statements.

Enums

CloneError

CloseError

Create

CreateError

CreateIfMissing

CreateOrEmpty

CreateTemp

CreateUnlinked

LockError

MetadataError

NoCreate

OpenError

ReadOnly

ReadWrite

SyncError

TempError

TryLockError

WriteOnly

Traits

AccessMode

OpenMode

Permanent

Read

Temporary

Write