Struct TreeRef

pub struct TreeRef<'a> {
    pub entries: Vec<EntryRef<'a>>,
}

A directory snapshot containing files (blobs), directories (trees) and submodules (commits).

Fields

entries: Vec<EntryRef<'a>>

The directories and files contained in this tree.

Beware that the sort order isn’t quite by name, so one may bisect only with a tree::EntryRef to handle ordering correctly.

Implementations

impl<'a> TreeRef<'a>

pub fn from_bytes(data: &'a [u8]) -> Result<TreeRef<'a>, Error>

Deserialize a Tree from data.

pub fn bisect_entry(&self, name: &BStr, is_dir: bool) -> Option<EntryRef<'a>>

Find an entry named name knowing if the entry is a directory or not, using a binary search.

Note that it’s impossible to binary search by name alone as the sort order is special.

pub const fn empty() -> TreeRef<'static>

Create an instance of the empty tree.

It’s particularly useful as static part of a program.

impl TreeRef<'_>

pub fn to_owned(&self) -> Tree

Convert this instance into its own version, creating a copy of all data.

This will temporarily allocate an extra copy in memory, so at worst three copies of the tree exist at some intermediate point in time. Use Self::into_owned() to avoid this.

pub fn into_owned(self) -> Tree

Convert this instance into its own version, creating a copy of all data.

Trait Implementations

impl<'a> Clone for TreeRef<'a>

fn clone(&self) -> TreeRef<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for TreeRef<'a>

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

Formats the value using the given formatter.

impl<'de: 'a, 'a> Deserialize<'de> for TreeRef<'a>

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<TreeRef<'_>> for Tree

fn from(other: TreeRef<'_>) -> Tree

Converts to this type from the input type.

impl<'a> From<TreeRef<'a>> for ObjectRef<'a>

fn from(v: TreeRef<'a>) -> Self

Converts to this type from the input type.

impl<'a> Hash for TreeRef<'a>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<'a> Ord for TreeRef<'a>

fn cmp(&self, other: &TreeRef<'a>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<'a> PartialEq for TreeRef<'a>

fn eq(&self, other: &TreeRef<'a>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

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

impl<'a> PartialOrd for TreeRef<'a>

fn partial_cmp(&self, other: &TreeRef<'a>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<'a> Serialize for TreeRef<'a>

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<'a> TryFrom<ObjectRef<'a>> for TreeRef<'a>

type Error = ObjectRef<'a>

The type returned in the event of a conversion error.

fn try_from(value: ObjectRef<'a>) -> Result<Self, Self::Error>

Performs the conversion.

impl WriteTo for TreeRef<'_>

Serialization

fn write_to(&self, out: &mut dyn Write) -> Result<()>

Serialize this tree to out in the git internal format.

fn kind(&self) -> Kind

Returns the type of this object.

fn size(&self) -> u64

Returns the size of this object’s representation (the amount of data which would be written by write_to).

fn loose_header(&self) -> SmallVec<[u8; 28]>

Returns a loose object header based on the object’s data

impl<'a> Eq for TreeRef<'a>

impl<'a> StructuralPartialEq for TreeRef<'a>