Struct SnapshotStore 

pub struct SnapshotStore<M: StoreMode> { /* private fields */ }

Implementations

impl SnapshotStore<ReadOnly>

pub fn open(root: impl Into<PathBuf>) -> Result<Self, StoreError>

impl SnapshotStore<Mutable>

pub fn open_mut(root: impl Into<PathBuf>) -> Result<Self, StoreError>

impl<M: StoreMode> SnapshotStore<M>

pub fn root(&self) -> &Path

pub fn project_dir(&self, project: &ProjectName) -> PathBuf

pub fn snapshot_path( &self, project: &ProjectName, tag: &TagName, ) -> Result<PathBuf, StoreError>

pub fn list_tags( &self, project: &ProjectName, ) -> Result<Vec<TagName>, StoreError>

pub fn read( &self, project: &ProjectName, tag: &TagName, ) -> Result<Snapshot<Canonical>, StoreError>

pub fn read_text( &self, project: &ProjectName, tag: &TagName, ) -> Result<String, StoreError>

The snapshot file as stored, so a caller can parse its header and its body from one read.

pub fn read_header( &self, project: &ProjectName, tag: &TagName, ) -> Result<SnapshotHeader, StoreError>

Reads and parses only the header block of a snapshot file.

pub fn has(&self, project: &ProjectName, tag: &TagName) -> bool

pub fn list_projects(&self) -> Result<Vec<ProjectName>, StoreError>

impl SnapshotStore<Mutable>

pub fn write( &self, snapshot: &Snapshot<Canonical>, ) -> Result<PathBuf, StoreError>

pub fn delete( &self, project: &ProjectName, tag: &TagName, ) -> Result<(), StoreError>

Trait Implementations

impl<M: Debug + StoreMode> Debug for SnapshotStore<M>

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

Formats the value using the given formatter.