Struct qualia::Store

pub struct Store { /* private fields */ }

A set of objects stored on disk.

Implementations

impl Store

pub fn open(path: impl AsRef<Path>) -> Result<Store>

Open a store at the given path.

pub fn all(&self) -> Collection<'_>

Get a Collection of all objects.

pub fn query(&self, query: impl Into<QueryNode>) -> Collection<'_>

Get a Collection of the objects matching the given query.

This can take either a QueryNode or QueryBuilder; you almost certainly want to use the latter.

pub fn cached_map<F: FnMut(Object, &Store) -> Result<O>, O>( &self, query: impl Into<QueryNode>, f: F ) -> Result<CachedMapping<F, O>>

Get a CachedMapping of the objects matching the given query.

Objects will be fetched ahead of time.

pub fn checkpoint(&mut self) -> Result<Checkpoint<'_>>

Start a Checkpoint on the store. All modifications must be done through a checkpoint.

This method takes a mutable reference to ensure that only one checkpoint can be active at a given time.

pub fn undo(&mut self) -> Result<Option<String>>

Undo all changes in the last checkpoint.

Returns the description of the undone checkpoint, if any. If no checkpoints exists, returns None.

pub fn last_checkpoint_id(&self) -> Result<CheckpointId>

Get the ID of the last checkpoint, if any.

pub fn modified_since(&self, a: CheckpointId) -> Result<bool>

Check if the store has been changed since the given checkpoint.