Struct checkpoint::storage::FileStorage

pub struct FileStorage { /* fields omitted */ }

Provides checkpoint storage via the file system.

Methods

impl FileStorage

pub fn open(path: &Path) -> Result<GuardWrapper<Self>>

Creates a FileStorage object around a new or existing file path and wraps the object in a GuardWrapper.

If path already exists it must point to a directory which contains two sub-folders, "committed" and "uncommitted".

Trait Implementations

impl Debug for FileStorage

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

Formats the value using the given formatter.

impl Storage for FileStorage

type Committed = Committed

The type representing committed checkpoints.

type Uncommitted = Uncommitted

The type representing uncommitted checkpoints.

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

Creates a new checkpoint with the specified identifier.

The checkpoint will not be saved permanently until it has been committed via the commit_checkpoint method.

Note: The provided identifier must be a valid filename.

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

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

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

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

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

Removes the committed checkpoint associated with the provided identifier.

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

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