Trait Persist

pub trait Persist: Deref + Send {
    type Error: Error + Send + Sync + 'static;

    // Required methods
    fn as_mut(&mut self) -> &mut Self::Target;
    fn persist(
        &mut self,
    ) -> impl Future<Output = Result<(), Self::Error>> + Send;
    fn into_value(self) -> Self::Target
       where Self::Target: Sized;
}

The Persist trait provides a wrapper around a value that can be saved in a persistent way. A minimal implementation provides an Error type, a persist function to persist the value, and an as_mut function to get a mutable reference to the value in memory.

LocalPersist is a non-Send version.

Required Associated Types

type Error: Error + Send + Sync + 'static

Required Methods

fn as_mut(&mut self) -> &mut Self::Target

Gets a mutable reference to the value. This is not expressed as a DerefMut bound because it is discouraged to use this function! Instead, use mutate.

fn persist(&mut self) -> impl Future<Output = Result<(), Self::Error>> + Send

Saves the value to persistent storage.

fn into_value(self) -> Self::Target

where Self::Target: Sized,

Takes the value out.

Dyn Compatibility

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementors

impl<T: Serialize + DeserializeOwned + Send> Persist for File<T>

type Error = Error

impl<T: Send> Persist for Memory<T>

type Error = Infallible

impl<W: Persist<Target = Wallet>> Persist for WalletState<W>

type Error = <W as Persist>::Error