Struct gix_index::extension::Tree

pub struct Tree {
    pub name: SmallVec<[u8; 23]>,
    pub id: ObjectId,
    pub num_entries: Option<u32>,
    pub children: Vec<Tree>,
}

A structure to associate object ids of a tree with sections in the index entries list.

It allows to more quickly build trees by avoiding as it can quickly reuse portions of the index and its associated tree ids if there was no change to them. Portions of this tree are invalidated as the index is changed.

Fields

name: SmallVec<[u8; 23]>

The name of the tree/directory, or empty if it’s the root tree.

id: ObjectId

The id of the directory tree of the associated tree object.

num_entries: Option<u32>

The amount of non-tree items in this directory tree, including sub-trees, recursively. The value of the top-level tree is thus equal to the value of the total amount of entries. If None, the tree is considered invalid and needs to be refreshed

children: Vec<Tree>

The child-trees below the current tree.

Implementations

impl Tree

pub fn verify(&self, use_objects: bool, objects: impl Find) -> Result<(), Error>

Validate the correctness of this instance. If use_objects is true, then objects will be used to access all objects.

impl Tree

pub fn write_to(&self, out: impl Write) -> Result<(), Error>

Serialize this instance to out.

Trait Implementations

impl Clone for Tree

fn clone(&self) -> Tree

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Tree

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

Formats the value using the given formatter.

impl PartialEq for Tree

fn eq(&self, other: &Tree) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for Tree

impl StructuralPartialEq for Tree