Skip to main content

FileStore

Struct FileStore 

Source
pub struct FileStore<S> { /* private fields */ }
Expand description

State held in one JSON document, so a second process — the next onevcs invocation — sees what the first one left.

Implementations§

Source§

impl<S: Serialize + DeserializeOwned + Checked> FileStore<S>

Source

pub fn attach(path: impl Into<PathBuf>, fallback: &S) -> Result<Self>

The store at path: whatever is already there, or fallback written out.

Attaching rather than replacing is what makes a second provider over the same path the same state — which is the whole reason to keep it in a file. A document that is there but is not this shape is refused here rather than at whichever call first read it.

Source

pub fn replace(path: impl Into<PathBuf>, state: &S) -> Result<Self>

The store at path, holding this state whatever was there before.

Written eagerly rather than on first use: a journey that reads the document before anything has driven the provider must find the scenario it seeded.

Source

pub fn path(&self) -> &Path

The document this state is kept in.

Trait Implementations§

Source§

impl<S> Clone for FileStore<S>

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<S: Debug> Debug for FileStore<S>

Source§

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

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

impl<S: Serialize + DeserializeOwned + Checked> Store<S> for FileStore<S>

Source§

fn with<R, F>(&self, act: F) -> Result<R>
where F: FnOnce(&mut S) -> Result<R>,

Read the state, act on it, and keep whatever the action left. Read more
Source§

fn snapshot(&self) -> Result<S>

The state as it stands.

Auto Trait Implementations§

§

impl<S> Freeze for FileStore<S>

§

impl<S> RefUnwindSafe for FileStore<S>
where S: RefUnwindSafe,

§

impl<S> Send for FileStore<S>
where S: Send,

§

impl<S> Sync for FileStore<S>
where S: Sync,

§

impl<S> Unpin for FileStore<S>
where S: Unpin,

§

impl<S> UnsafeUnpin for FileStore<S>

§

impl<S> UnwindSafe for FileStore<S>
where S: UnwindSafe,

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> Same for T

Source§

type Output = T

Should always be Self
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 = 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.