Skip to main content

CreateDirectoryOptions

Struct CreateDirectoryOptions 

Source
#[non_exhaustive]
pub struct CreateDirectoryOptions { /* private fields */ }
Expand description

Options controlling directory or collection creation.

§Examples

use qubit_fs::directory::CreateDirectoryOptions;

assert!(!CreateDirectoryOptions::default().recursive());

Implementations§

Source§

impl CreateDirectoryOptions

Source

pub const fn recursive(&self) -> bool

Returns whether missing parent directories should be created.

§Returns

true when missing parent directories should be created.

Source

pub const fn exists_ok(&self) -> bool

Returns whether an existing directory should be accepted.

§Returns

true when creating a directory that already exists is allowed.

Source

pub const fn user_metadata(&self) -> &NonSensitiveMetadata

Returns validated user-defined metadata.

§Returns

The metadata associated with these creation options.

Source

pub const fn with_recursive(self, recursive: bool) -> Self

Replaces recursive parent creation.

§Parameters

recursive enables creation of missing parent directories when true.

§Returns

These options with recursive parent creation set to recursive.

Source

pub const fn with_exists_ok(self, exists_ok: bool) -> Self

Replaces acceptance of an existing directory.

§Parameters

exists_ok enables accepting an already existing directory when true.

§Returns

These options with existing-directory acceptance set to exists_ok.

Source

pub fn with_user_metadata(self, metadata: UserMetadata) -> Self

Replaces user-defined metadata that has already passed key validation.

§Parameters

metadata is the validated metadata to associate with these options.

§Returns

These options with metadata wrapped as non-sensitive metadata.

Trait Implementations§

Source§

impl Clone for CreateDirectoryOptions

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for CreateDirectoryOptions

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for CreateDirectoryOptions

Source§

fn default() -> Self

Creates non-recursive options that reject an existing directory.

§Returns

Options with recursive creation and acceptance of an existing directory disabled, and with no user metadata.

Source§

impl PartialEq for CreateDirectoryOptions

Source§

fn eq(&self, other: &Self) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for CreateDirectoryOptions

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.