Struct Cursor

pub struct Cursor<'a, 'find> { /* private fields */ }

A way to constrain all tree-edits to a given subtree.

Implementations

impl Cursor<'_, '_>

pub fn get<I, C>(&self, rela_path: I) -> Option<&Entry>

where I: IntoIterator<Item = C>, C: AsRef<BStr>,

Obtain the entry at rela_path or return None if none was found, or the tree wasn’t yet written to that point. Note that after writing only the root path remains, all other intermediate trees are removed. The entry can be anything that can be stored in a tree, but may have a null-id if it’s a newly inserted tree. Also, ids of trees might not be accurate as they may have been changed in memory.

pub fn upsert<I, C>( &mut self, rela_path: I, kind: EntryKind, id: ObjectId, ) -> Result<&mut Self, Error>

where I: IntoIterator<Item = C>, C: AsRef<BStr>,

Like Editor::upsert(), but with the constraint of only editing in this cursor’s tree.

pub fn remove<I, C>(&mut self, rela_path: I) -> Result<&mut Self, Error>

where I: IntoIterator<Item = C>, C: AsRef<BStr>,

Like Editor::remove(), but with the constraint of only editing in this cursor’s tree.

pub fn write<E>( &mut self, out: impl FnMut(&Tree) -> Result<ObjectId, E>, ) -> Result<ObjectId, E>

Like Editor::write(), but will write only the subtree of the cursor.