zec
/
incrementalmerkletree
mirror of https://github.com/zcash/incrementalmerkletree.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

shardtree: Clarify documentation for `ShardStore::remove_checkpoint` 

`CachingShardStore` relies on this method being a no-op when the
checkpoint doesn't exist.
This commit is contained in:
Jack Grigg 2023-07-17 20:56:53 +00:00
parent f5160a4790
commit 7ec75fdd91
1 changed files with 3 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
shardtree/src/lib.rs
View File

@ -179,9 +179,11 @@ pub trait ShardStore {
F: Fn(&mut Checkpoint) -> Result<(), Self::Error>;
/// Removes a checkpoint from the data store.
///
/// If no checkpoint exists with the given ID, this does nothing.
fn remove_checkpoint(&mut self, checkpoint_id: &Self::CheckpointId) -> Result<(), Self::Error>;
/// Removes checkpoints with identifiers greater than or equal to the given identifier
/// Removes checkpoints with identifiers greater than or equal to the given identifier.
fn truncate_checkpoints(
&mut self,
checkpoint_id: &Self::CheckpointId,