Struct nuts_directory::CreateOptions

pub struct CreateOptions { /* private fields */ }

Options needed to create the backend.

You must pass the path, where the directory tree should be stored, to CreateOptions::for_path(), if creating a CreateOptions instance.

Furthermore the following options can be specified:

• CreateOptions::with_overwrite(): If set to true an already existing path is reused. Note: If you overwrite an existing path, the content is not removed! If set to false and the base path exists, the build operation aborts with Error::Exists. The default is false.
• CreateOptions::with_bsize(): Specifies the block size of the backend. This is the number of bytes, which can be stored in an individual block. The minimum block size is 512 bytes. The default is 512.

Implementations

impl CreateOptions

pub fn for_path<P: AsRef<Path>>(path: P) -> Self

Creates a new CreateOptions instance.

You must pass the path, where the directory tree should be stored, to the function.

For further options default values are applied.

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

Assigns a new overwrite flag to the options.

If set to true an already existing path is reused. Note: If you overwrite an existing path, the content is not removed! If set to false and the base path exists, the build operation aborts with Error::Exists.

pub fn with_bsize(self, bsize: u32) -> Self

Assigns a new block size to the options.

This is the number of bytes, which can be stored in an individual block.

Trait Implementations

impl Clone for CreateOptions

fn clone(&self) -> CreateOptions

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Create<DirectoryBackend> for CreateOptions

fn settings(&self) -> Settings

Returns the settings of this backend instance.

fn build(self) -> Result<DirectoryBackend, Error>

Create an instance of the Backend.

impl Debug for CreateOptions

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

Formats the value using the given formatter.

impl From<CreateOptions> for Settings

fn from(options: CreateOptions) -> Self

Converts to this type from the input type.

impl HeaderSet<DirectoryBackend> for CreateOptions

fn put_header_bytes(&mut self, bytes: &[u8; 512]) -> Result<(), Error>

Puts the given bytes into the header of the backend.