Struct checkpoint::wrappers::GuardWrapper

pub struct GuardWrapper<T> { /* fields omitted */ }

Protects checkpoint data by ensuring that no two uncommitted checkpoints can have the same identifier and that committed checkpoints cannot be removed while in use (i.e. have a binding created by either the commit_checkpoint method or the load_checkpoint method).

Protection is limited to interactions with a single GuardWrapper object directly.

For example, if multiple guarded FileStorage objects are opened with the same path, it is possible for one of them to remove a checkpoint even if the others have the same checkpoint marked as in-use.

Furthermore, GuardWrapper objects offer no protection against outside processes which may be operating on the underlying storage medium.

Methods

impl<T: Storage> GuardWrapper<T>

pub fn wrap(inner: T) -> Result<Self, Error>

Adds a GuardWrapper around a Storage object.

Trait Implementations

impl<T: Debug> Debug for GuardWrapper<T>

fn fmt(&self, __arg_0: &mut Formatter) -> Result

Formats the value using the given formatter.

impl<T: Storage> Storage for GuardWrapper<T>

type Committed = Committed<T::Committed>

The type representing committed checkpoints.

type Uncommitted = Uncommitted<T::Uncommitted>

The type representing uncommitted checkpoints.

fn create_checkpoint(
    &mut self,
    identifier: &str
) -> Result<Self::Uncommitted, Error>

Creates a new checkpoint with the specified identifier.

fn commit_checkpoint(
    &mut self,
    uncommitted: Self::Uncommitted
) -> Result<Self::Committed, Error>

Commits an uncommitted checkpoint, permanently saving its data to the underlying storage medium.

fn load_checkpoint(
    &mut self,
    identifier: &str
) -> Result<Self::Committed, Error>

Loads the committed checkpoint associated with the provided identifier, allowing its data to be retrieved.

fn remove_checkpoint(&mut self, identifier: &str) -> Result<(), Error>

Removes the committed checkpoint associated with the provided identifier.

fn checkpoint_identifiers(&mut self) -> Result<Vec<String>, Error>

Returns a list of all committed checkpoint identifiers in the underlying storage medium.