Struct Cache 

pub struct Cache<R, C> { /* private fields */ }

A Patch store that relies on the cache for reads and as a write-through cache.

The store is used for the main storage when performing a write-through. It is also used for identifying which RepoId is being used for the cache.

Implementations

impl<R, C> Cache<R, C>

pub fn new(store: R, cache: C) -> Self

pub fn rid(&self) -> RepoId

where R: HasRepoId,

impl<'a, R, C> Cache<Patches<'a, R>, C>

pub fn create<'g, G>( &'g mut self, title: Title, description: impl ToString, target: MergeTarget, base: impl Into<Oid>, oid: impl Into<Oid>, labels: &[Label], signer: &Device<G>, ) -> Result<PatchMut<'a, 'g, R, C>, Error>

where R: WriteRepository + Store<Namespace = NodeId>, G: Signer<Signature>, C: Update<Patch>,

Create a new Patch using the super::Patches as the main storage, and writing the update to the cache.

pub fn draft<'g, G>( &'g mut self, title: Title, description: impl ToString, target: MergeTarget, base: impl Into<Oid>, oid: impl Into<Oid>, labels: &[Label], signer: &Device<G>, ) -> Result<PatchMut<'a, 'g, R, C>, Error>

where R: WriteRepository + Store<Namespace = NodeId>, G: Signer<Signature>, C: Update<Patch>,

Create a new Patch, in a draft state, using the super::Patches as the main storage, and writing the update to the cache.

pub fn remove<G>( &mut self, id: &PatchId, signer: &Device<G>, ) -> Result<(), Error>

where G: Signer<Signature>, R: ReadRepository + SignRepository + Store<Namespace = NodeId>, C: Remove<Patch>,

Remove the given id from the super::Patches storage, and removing the entry from the cache.

pub fn write(&mut self, id: &PatchId) -> Result<(), Error>

where R: ReadRepository + Store, C: Update<Patch>,

Read the given id from the super::Patches store and writing it to the cache.

pub fn write_all( &mut self, callback: impl Fn(&Result<(PatchId, Patch), Error>, &Progress) -> ControlFlow<()>, ) -> Result<(), Error>

where R: ReadRepository + Store, C: Update<Patch> + Remove<Patch>,

Read all the patches from the super::Patches store and writing them to cache.

The callback is used for reporting success, failures, and progress to the caller. The caller may also decide to continue or break from the process.

impl<R> Cache<R, StoreReader>

pub fn reader(store: R, cache: StoreReader) -> Self

impl<R> Cache<R, StoreWriter>

pub fn open(store: R, cache: StoreWriter) -> Self

impl<'a, R> Cache<Patches<'a, R>, StoreWriter>

where R: ReadRepository + Store,

pub fn get_mut<'g>( &'g mut self, id: &ObjectId, ) -> Result<PatchMut<'a, 'g, R, StoreWriter>, Error>

Get the PatchMut, identified by id, using the StoreWriter for retrieving the Patch.

impl<'a, R> Cache<Patches<'a, R>, NoCache>

where R: ReadRepository + Store<Namespace = NodeId>,

pub fn no_cache(repository: &'a R) -> Result<Self, RepositoryError>

Get a Cache that does no write-through modifications and uses the super::Patches store for all reads and writes.

pub fn get_mut<'g>( &'g mut self, id: &ObjectId, ) -> Result<PatchMut<'a, 'g, R, NoCache>, Error>

Get the PatchMut, identified by id.

Trait Implementations

impl<R> Patches for Cache<Patches<'_, R>, NoCache>

where R: ReadRepository + Store<Namespace = NodeId>,

type Error = Error

type Iter<'b> = NoCacheIter<'b> where Self: 'b

An iterator for returning a set of patches from the store.

fn get(&self, id: &PatchId) -> Result<Option<Patch>, Self::Error>

Get the Patch, identified by id, returning None if it was not found.

fn find_by_revision( &self, id: &RevisionId, ) -> Result<Option<ByRevision>, Self::Error>

Get the Patch and its Revision, identified by the revision id, returning None if it was not found.

fn list(&self) -> Result<Self::Iter<'_>, Self::Error>

List all patches that are in the store.

fn list_by_status(&self, status: &Status) -> Result<Self::Iter<'_>, Self::Error>

List all patches in the store that match the provided status.

fn counts(&self) -> Result<PatchCounts, Self::Error>

Get the PatchCounts of all the patches in the store.

fn opened(&self) -> Result<Self::Iter<'_>, Self::Error>

List all opened patches in the store.

fn archived(&self) -> Result<Self::Iter<'_>, Self::Error>

List all archived patches in the store.

fn drafted(&self) -> Result<Self::Iter<'_>, Self::Error>

List all drafted patches in the store.

fn merged(&self) -> Result<Self::Iter<'_>, Self::Error>

List all merged patches in the store.

fn is_empty(&self) -> Result<bool, Self::Error>

Returns true if there are no patches in the store.

impl<R> Patches for Cache<R, StoreReader>

where R: HasRepoId,

type Error = Error

type Iter<'b> = PatchesIter<'b> where Self: 'b

An iterator for returning a set of patches from the store.

fn get(&self, id: &PatchId) -> Result<Option<Patch>, Self::Error>

Get the Patch, identified by id, returning None if it was not found.

fn find_by_revision(&self, id: &RevisionId) -> Result<Option<ByRevision>, Error>

Get the Patch and its Revision, identified by the revision id, returning None if it was not found.

fn list(&self) -> Result<Self::Iter<'_>, Self::Error>

List all patches that are in the store.

fn list_by_status(&self, status: &Status) -> Result<Self::Iter<'_>, Self::Error>

List all patches in the store that match the provided status.

fn counts(&self) -> Result<PatchCounts, Self::Error>

Get the PatchCounts of all the patches in the store.

fn opened(&self) -> Result<Self::Iter<'_>, Self::Error>

List all opened patches in the store.

fn archived(&self) -> Result<Self::Iter<'_>, Self::Error>

List all archived patches in the store.

fn drafted(&self) -> Result<Self::Iter<'_>, Self::Error>

List all drafted patches in the store.

fn merged(&self) -> Result<Self::Iter<'_>, Self::Error>

List all merged patches in the store.

fn is_empty(&self) -> Result<bool, Self::Error>

Returns true if there are no patches in the store.

impl<R> Patches for Cache<R, StoreWriter>

where R: HasRepoId,

type Error = Error

type Iter<'b> = PatchesIter<'b> where Self: 'b

An iterator for returning a set of patches from the store.

fn get(&self, id: &PatchId) -> Result<Option<Patch>, Self::Error>

Get the Patch, identified by id, returning None if it was not found.

fn find_by_revision(&self, id: &RevisionId) -> Result<Option<ByRevision>, Error>

Get the Patch and its Revision, identified by the revision id, returning None if it was not found.

fn list(&self) -> Result<Self::Iter<'_>, Self::Error>

List all patches that are in the store.

fn list_by_status(&self, status: &Status) -> Result<Self::Iter<'_>, Self::Error>

List all patches in the store that match the provided status.

fn counts(&self) -> Result<PatchCounts, Self::Error>

Get the PatchCounts of all the patches in the store.

fn opened(&self) -> Result<Self::Iter<'_>, Self::Error>

List all opened patches in the store.

fn archived(&self) -> Result<Self::Iter<'_>, Self::Error>

List all archived patches in the store.

fn drafted(&self) -> Result<Self::Iter<'_>, Self::Error>

List all drafted patches in the store.

fn merged(&self) -> Result<Self::Iter<'_>, Self::Error>

List all merged patches in the store.

fn is_empty(&self) -> Result<bool, Self::Error>

Returns true if there are no patches in the store.

impl<R, C> Remove<Patch> for Cache<R, C>

where C: Remove<Patch>,

type Out = <C as Remove<Patch>>::Out

The output type, if any, for a successful removal.

type RemoveError = <C as Remove<Patch>>::RemoveError

fn remove(&mut self, id: &ObjectId) -> Result<Self::Out, Self::RemoveError>

Delete an object in the COB cache.

fn remove_all(&mut self, rid: &RepoId) -> Result<Self::Out, Self::RemoveError>

Delete all entries from a repo.

impl<R, C> Update<Patch> for Cache<R, C>

where C: Update<Patch>,

type Out = <C as Update<Patch>>::Out

The output type, if any, for a successful update.

type UpdateError = <C as Update<Patch>>::UpdateError

fn update( &mut self, rid: &RepoId, id: &ObjectId, object: &Patch, ) -> Result<Self::Out, Self::UpdateError>