Struct git_odb::loose::object::Object

pub struct Object {
    pub kind: Kind,
    pub size: usize,
    // some fields omitted
}

A representation of a loose object on disk, which is fully or partially read into memory

Fields

kind: Kind

The kind of object

size: usize

The uncompressed size of the object's data/payload

Implementations

impl Object

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

Decode the object to make it's fields accessible in case of Trees, Tags and Commits.

This is a zero-copy operation with data read from disk if needed and stored in memory. The returned borrowed::Object references this data where possible.

Note: Blobs are also loaded into memory and are made available that way. Consider using stream() if large Blobs are expected.

pub fn stream(&mut self) -> Result<Reader<'_>, Error>

Returns an implementation of std::io::Read, which decompresses the objects data on the fly.

Note: This is most useful for big blobs as these won't be read into memory in full. Use decode() for Trees, Tags and Commits instead for convenient access to their payload.

impl Object

pub fn verify_checksum(&mut self, desired: Id<'_>) -> Result<(), Error>

Generate the git hash of this object, reading it in the process, and compare it with the given desired Id.

Returns an error with the actual id if the hashes don't match.

Trait Implementations

impl Clone for Object

fn clone(&self) -> Object

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Object

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

Formats the value using the given formatter.

impl Eq for Object

impl Hash for Object

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, 

Feeds a slice of this type into the given Hasher.

impl Ord for Object

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

This method returns an Ordering between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl PartialEq<Object> for Object

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

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

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

This method tests for !=.

impl PartialOrd<Object> for Object

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

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

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

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

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

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

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

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

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

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

impl StructuralEq for Object

impl StructuralPartialEq for Object