Struct MmapOptions 

#[non_exhaustive]
pub struct MmapOptions {
    pub mode: OpenMode,
    pub initial_len: Option<u64>,
    pub path: PathBuf,
}

Options for opening a MmapResource.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

mode: OpenMode

Open mode controlling read/write behavior for existing files.

initial_len: Option<u64>

Initial file size for new files. Ignored for existing files.

path: PathBuf

Path to the backing file.

Implementations

impl MmapOptions

pub fn builder() -> MmapOptionsBuilder

Create an instance of MmapOptions using the builder syntax

impl MmapOptions

pub fn new(path: PathBuf) -> Self

Options for the given backing-file path with all other fields at their builder defaults. For chains use MmapOptions::for_path.

pub fn for_path(path: PathBuf) -> MmapOptionsBuilder<SetPath>

Chainable counterpart to MmapOptions::new: returns a builder with path set so callers can attach .mode(...) / .initial_len(...) then .build().

Trait Implementations

impl Clone for MmapOptions

fn clone(&self) -> MmapOptions

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for MmapOptions

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.