Struct git_odb::data::Object

pub struct Object<'a> {
    pub kind: Kind,
    pub data: &'a [u8],
    // some fields omitted
}

A borrowed object using a borrowed slice as backing buffer.

Fields

kind: Kind

kind of object

data: &'a [u8]

decoded, decompressed data, owned by a backing store.

Implementations

impl Object<'_>

pub fn verify_checksum(&self, desired: impl AsRef<oid>) -> Result<(), Error>

Compute the checksum of self and compare it with the desired hash. If the hashes do not match, an Error is returned, containing the actual hash of self.

impl<'a> Object<'a>

pub fn new(kind: Kind, data: &'a [u8]) -> Object<'a>

Constructs a new data object from kind and data.

pub fn decode(&self) -> Result<Object<'a>, Error>

Decodes the data in the backing slice into a git_object::immutable::Object, allowing to access all of its data conveniently. The cost of parsing an object is negligible.

Note that mutable, decoded objects can be created from a crate::data::Object using git_object::immutable::Object::into_mutable().

pub fn into_tree_iter(self) -> Option<TreeIter<'a>>

Returns this object as tree iterator to parse entries one at a time to avoid allocations, or None if this is not a tree object.

pub fn into_commit_iter(self) -> Option<CommitIter<'a>>

Returns this object as commit iterator to parse tokens one at a time to avoid allocations, or None if this is not a commit object.

Trait Implementations

impl<'a> Clone for Object<'a>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Object<'a>

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

Formats the value using the given formatter.

impl<'a> Eq for Object<'a>

impl<'a> Hash for Object<'a>

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl<'a> Ord for Object<'a>

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

This method returns an Ordering between self and other.

#[must_use]

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

Compares and returns the maximum of two values.

#[must_use]

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

Compares and returns the minimum of two values.

#[must_use]

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

Restrict a value to a certain interval.

impl<'a> PartialEq<Object<'a>> for Object<'a>

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

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

fn ne(&self, other: &Object<'a>) -> bool

This method tests for !=.

impl<'a> PartialOrd<Object<'a>> for Object<'a>

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

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

#[must_use]

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

This method tests less than (for self and other) and is used by the < operator.

#[must_use]

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

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

#[must_use]

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

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]

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

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

impl<'a> StructuralEq for Object<'a>

impl<'a> StructuralPartialEq for Object<'a>