Struct git2::TreeBuilder

pub struct TreeBuilder<'repo> { /* private fields */ }

Constructor for in-memory trees (low-level)

You probably want to use build::TreeUpdateBuilder instead.

This is the more raw of the two tree update facilities. It handles only one level of a nested tree structure at a time. Each path passed to insert etc. must be a single component.

Implementations

impl<'repo> TreeBuilder<'repo>

pub fn clear(&mut self) -> Result<(), Error>

Clear all the entries in the builder

pub fn len(&self) -> usize

Get the number of entries

pub fn is_empty(&self) -> bool

Return true if there is no entry

pub fn get<P>(&self, filename: P) -> Result<Option<TreeEntry<'_>>, Error>

where P: IntoCString,

Get en entry from the builder from its filename

pub fn insert<P: IntoCString>( &mut self, filename: P, oid: Oid, filemode: i32, ) -> Result<TreeEntry<'_>, Error>

Add or update an entry in the builder

No attempt is made to ensure that the provided Oid points to an object of a reasonable type (or any object at all).

The mode given must be one of 0o040000, 0o100644, 0o100755, 0o120000 or 0o160000 currently.

pub fn remove<P: IntoCString>(&mut self, filename: P) -> Result<(), Error>

Remove an entry from the builder by its filename

pub fn filter<F>(&mut self, filter: F) -> Result<(), Error>

where F: FnMut(&TreeEntry<'_>) -> bool,

Selectively remove entries from the tree

Values for which the filter returns true will be kept. Note that this behavior is different from the libgit2 C interface.

pub fn write(&self) -> Result<Oid, Error>

Write the contents of the TreeBuilder as a Tree object and return its Oid

Trait Implementations

impl<'repo> Drop for TreeBuilder<'repo>

fn drop(&mut self)

Executes the destructor for this type.