Struct Tree

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

A structure to represent a git tree

Implementations

impl<'repo> Tree<'repo>

pub fn id(&self) -> Oid

Get the id (SHA1) of a repository object

pub fn len(&self) -> usize

Get the number of entries listed in this tree.

pub fn is_empty(&self) -> bool

Return true if there is not entry

pub fn iter(&self) -> TreeIter<'_>

Returns an iterator over the entries in this tree.

pub fn walk<C, T>(&self, mode: TreeWalkMode, callback: C) -> Result<(), Error>

where C: FnMut(&str, &TreeEntry<'_>) -> T, T: Into<i32>,

Traverse the entries in a tree and its subtrees in post or pre-order. The callback function will be run on each node of the tree that’s walked. The return code of this function will determine how the walk continues.

libgit2 requires that the callback be an integer, where 0 indicates a successful visit, 1 skips the node, and -1 aborts the traversal completely. You may opt to use the enum TreeWalkResult instead.

let mut ct = 0;
tree.walk(TreeWalkMode::PreOrder, |_, entry| {
    assert_eq!(entry.name(), Some("foo"));
    ct += 1;
    TreeWalkResult::Ok
}).unwrap();
assert_eq!(ct, 1);

See libgit2 documentation for more information.

pub fn get_id(&self, id: Oid) -> Option<TreeEntry<'_>>

Lookup a tree entry by SHA value.

pub fn get(&self, n: usize) -> Option<TreeEntry<'_>>

Lookup a tree entry by its position in the tree

pub fn get_name(&self, filename: &str) -> Option<TreeEntry<'_>>

Lookup a tree entry by its filename

pub fn get_name_bytes(&self, filename: &[u8]) -> Option<TreeEntry<'_>>

Lookup a tree entry by its filename, specified as bytes.

This allows for non-UTF-8 filenames.

pub fn get_path(&self, path: &Path) -> Result<TreeEntry<'static>, Error>

Retrieve a tree entry contained in a tree or in any of its subtrees, given its relative path.

pub fn as_object(&self) -> &Object<'repo>

Casts this Tree to be usable as an Object

pub fn into_object(self) -> Object<'repo>

Consumes this Tree to be returned as an Object

Trait Implementations

impl<'repo> Clone for Tree<'repo>

fn clone(&self) -> Tree<'repo>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'repo> Debug for Tree<'repo>

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl<'repo> Drop for Tree<'repo>

fn drop(&mut self)

Executes the destructor for this type.

impl<'repo, 'iter> IntoIterator for &'iter Tree<'repo>

type Item = TreeEntry<'iter>

The type of the elements being iterated over.

type IntoIter = TreeIter<'iter>

Which kind of iterator are we turning this into?

fn into_iter(self) -> <&'iter Tree<'repo> as IntoIterator>::IntoIter

Creates an iterator from a value.