Struct MappedFile 

pub struct MappedFile { /* private fields */ }

Read-only memory map of a file.

Holds the File so the mapping remains valid for the lifetime of this value. The map borrows no path and therefore remains usable if the directory entry is renamed after opening.

Consumers should treat mapped files as immutable sealed artifacts. External truncation or mutation while a map is live may produce platform-dependent behavior.

Implementations

impl MappedFile

pub fn open(path: impl AsRef<Path>) -> Result<Self>

Open path read-only and map the whole file.

Errors

Returns I/O errors from open or mmap.

Mapping contract

Although this method is safe to call, memmap2 cannot prevent another process from truncating or rewriting the file. The caller must ensure the path follows an immutable/sealed-file convention while mapped.

pub fn as_bytes(&self) -> &[u8]

Borrow the complete mapped file as bytes.

The slice remains valid for the lifetime of self.

pub fn len(&self) -> usize

Return the mapped file length in bytes.

pub fn is_empty(&self) -> bool

Return whether the mapped file has zero bytes.

Trait Implementations

impl AsRef<[u8]> for MappedFile

fn as_ref(&self) -> &[u8]

Converts this type into a shared reference of the (usually inferred) input type.