Struct StorageOpenOptions 

pub struct StorageOpenOptions { /* private fields */ }

Parameters from which a storage object can be constructed.

Implementations

impl StorageOpenOptions

pub fn new() -> Self

Create default options.

pub fn filename<P: AsRef<Path>>(self, filename: P) -> Self

Set a filename to open.

pub fn write(self, write: bool) -> Self

Whether the storage should be writable or not.

pub fn direct(self, direct: bool) -> Self

Whether to bypass the host page cache (if applicable).

pub fn write_dontcache(self, write_dontcache: bool) -> Self

Available on Linux and (GNU or musl) only.

GNU/musl Linux-only: whether buffered writes should avoid remaining in the host page cache.

This is a best-effort per-write hint. It requires writable, buffered storage and is rejected when combined with read-only or direct I/O. Unsupported kernels and filesystems are detected from the write syscall itself, after which writes continue without the hint. This hint neither bounds dirty memory nor changes the storage durability contract. Dynamically linked GNU builds require glibc 2.26 or newer for pwritev2().

pub fn get_filename(&self) -> Option<&Path>

Get the set filename (if any).

pub fn get_writable(&self) -> bool

Return the set writable state.

pub fn get_direct(&self) -> bool

Return the set direct state.

pub fn get_write_dontcache(&self) -> bool

Available on Linux and (GNU or musl) only.

GNU/musl Linux-only: return whether buffered writes should avoid remaining in the host page cache.

Trait Implementations

impl Clone for StorageOpenOptions

fn clone(&self) -> StorageOpenOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StorageOpenOptions

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

Formats the value using the given formatter.

impl Default for StorageOpenOptions

fn default() -> StorageOpenOptions

Returns the “default value” for a type.