Struct gix_pack::data::output::Entry

pub struct Entry {
    pub id: ObjectId,
    pub kind: Kind,
    pub decompressed_size: usize,
    pub compressed_data: Vec<u8>,
}

Available on crate feature generate only.

An entry to be written to a file.

Some of these will be in-flight and in memory while waiting to be written. Memory requirements depend on the amount of compressed data they hold.

Fields

id: ObjectId

The hash of the object to write

kind: Kind

The kind of entry represented by data. It’s used alongside with it to complete the pack entry at rest or in transit.

decompressed_size: usize

The size in bytes needed once data gets decompressed

compressed_data: Vec<u8>

The compressed data right behind the header

Implementations

impl Entry

pub fn invalid() -> Entry

An object which can be identified as invalid easily which happens if objects didn’t exist even if they were referred to.

pub fn is_invalid(&self) -> bool

Returns true if this object doesn’t really exist but still has to be handled responsibly

Note that this is true for tree entries that are commits/git submodules, or for objects which aren’t present in our local clone due to shallow clones.

pub fn from_pack_entry( entry: Entry, count: &Count, potential_bases: &[Count], bases_index_offset: usize, pack_offset_to_oid: Option<impl FnMut(u32, u64) -> Option<ObjectId>>, target_version: Version, ) -> Option<Result<Self, Error>>

Create an Entry from a previously counted object which is located in a pack. It’s entry is provided here. The version specifies what kind of target Entry version the caller desires.

pub fn from_data(count: &Count, obj: &Data<'_>) -> Result<Self, Error>

Create a new instance from the given oid and its corresponding git object data obj.

pub fn to_entry_header( &self, version: Version, index_to_base_distance: impl FnOnce(usize) -> u64, ) -> Header

Transform ourselves into pack entry header of version which can be written into a pack.

index_to_pack(object_index) -> pack_offset is a function to convert the base object’s index into the input object array (if each object is numbered) to an offset into the pack. This information is known to the one calling the method.

Trait Implementations

impl Clone for Entry

fn clone(&self) -> Entry

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Entry

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Entry

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for Entry

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 Ord for Entry

fn cmp(&self, other: &Entry) -> 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 + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for Entry

fn eq(&self, other: &Entry) -> 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 PartialOrd for Entry

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

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

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

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

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

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

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

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

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 Serialize for Entry

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Entry

impl StructuralPartialEq for Entry