Skip to main content

StoreBuilder

Struct StoreBuilder 

Source
pub struct StoreBuilder<'a, T: Sized + Serialize> { /* private fields */ }
Expand description

Builder for storing a value with fine-grained options.

Created via StoreConfigFile::store_opts. Configure with pretty, overwrite and format, then call execute to write the file.

Defaults: pretty on, overwrite on, format auto-detected from the path extension (i.e. the same behavior as StoreConfigFile::store).

Implementations§

Source§

impl<'a, T: Sized + Serialize> StoreBuilder<'a, T>

Source

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

Toggle pretty-printing. Default: true. Formats without a pretty variant (xml/yaml/json5) ignore this.

Source

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

Toggle overwriting an existing file. Default: true. When false, execute returns Error::FileExists if the file already exists.

Source

pub const fn format(self, config_format: ConfigFormat) -> Self

Use a specific ConfigFormat, overriding extension-based detection.

Source

pub fn execute(&self) -> Result<()>

Store the value with the configured options.

§Errors

Trait Implementations§

Source§

impl<T: Sized + Serialize> Debug for StoreBuilder<'_, T>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<'a, T> Freeze for StoreBuilder<'a, T>

§

impl<'a, T> RefUnwindSafe for StoreBuilder<'a, T>
where T: RefUnwindSafe,

§

impl<'a, T> Send for StoreBuilder<'a, T>
where T: Sync,

§

impl<'a, T> Sync for StoreBuilder<'a, T>
where T: Sync,

§

impl<'a, T> Unpin for StoreBuilder<'a, T>

§

impl<'a, T> UnsafeUnpin for StoreBuilder<'a, T>

§

impl<'a, T> UnwindSafe for StoreBuilder<'a, T>
where T: RefUnwindSafe,

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> 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, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.