Struct StorageCreateOptions

pub struct StorageCreateOptions {
    pub(crate) open_opts: StorageOpenOptions,
    pub(crate) size: u64,
    pub(crate) prealloc_mode: PreallocateMode,
    pub(crate) overwrite: bool,
}

Parameters from which a new storage object can be created.

Fields

open_opts: StorageOpenOptions

Options to open the image, includes the filename.

writable should be ignored, created files should always be opened as writable.

size: u64

Initial size.

prealloc_mode: PreallocateMode

Preallocation mode.

overwrite: bool

Whether to overwrite an existing file.

Implementations

impl StorageCreateOptions

pub fn new() -> Self

Create default options.

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

Set the filename of the file to create.

pub fn size(self, size: u64) -> Self

Set the initial size.

pub fn preallocate(self, prealloc_mode: PreallocateMode) -> Self

Set the desired preallocation mode.

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

Whether to overwrite an existing file.

pub fn modify_open_opts<F: FnOnce(StorageOpenOptions) -> StorageOpenOptions>( self, f: F, ) -> Self

Modify the options used for opening the file.

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

Get the set filename (if any).

pub fn get_size(&self) -> u64

Get the set size.

pub fn get_preallocate(&self) -> PreallocateMode

Get the preallocation mode.

pub fn get_overwrite(&self) -> bool

Check whether to overwrite an existing file.

pub fn get_open_options(self) -> StorageOpenOptions

Get the options for opening the created file.

Trait Implementations

impl Clone for StorageCreateOptions

fn clone(&self) -> StorageCreateOptions

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for StorageCreateOptions

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

Formats the value using the given formatter.

impl Default for StorageCreateOptions

fn default() -> Self

Returns the “default value” for a type.