Struct Vow 

pub struct Vow<T, F> { /* private fields */ }

Synchronously binds data to a file.

Implementations

impl<T, F> Vow<T, F>

pub fn get(&self) -> &T

Get the value.

impl<T, F> Vow<T, F>

where T: Data, F: VowFile,

pub fn set(&mut self, value: T) -> VowResult<()>

Set the value.

pub fn map<U>(&mut self, f: U) -> VowResult<()>

where U: FnOnce(T) -> T + MaybeSend,

Map the value.

pub fn update<U>(&mut self, f: U) -> VowResult<()>

where U: FnOnce(&mut T) + MaybeSend,

Update the value.

pub fn force_reload(&mut self) -> VowResult<()>

Force reload the value.

pub fn flush(&mut self) -> VowResult<()>

Flush the content down to disk.

impl<T, F> Vow<T, F>

where T: Data, F: VowFile,

pub fn new(file: F) -> VowResult<Self>

Create a new Vow instance with content stored in file.

This will fail if the file contains invalid data.

impl Vow<Infallible, File>

pub fn open<P: AsRef<Path>>( path: P, ) -> VowBuilder<Nothing<Infallible>, File, Blocking, Json>

Open a blocking file at the given path.

impl<F> Vow<Infallible, F>

pub const fn builder( file: F, ) -> VowBuilder<Nothing<Infallible>, F, Blocking, Json>

Create a new builder for Vow.

Trait Implementations

impl<T: Clone, F: Clone> Clone for Vow<T, F>

fn clone(&self) -> Vow<T, F>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug, F: Debug> Debug for Vow<T, F>

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

Formats the value using the given formatter.

impl<T, F> Deref for Vow<T, F>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.