Enum git_hash::ObjectId

pub enum ObjectId {
    Sha1([u8; 20]),
}

An owned hash identifying objects, most commonly Sha1

Variants

Sha1

Tuple Fields of Sha1

0: [u8; 20]

Implementations

impl ObjectId

Access and conversion

pub fn kind(&self) -> Kind

Returns the kind of hash used in this Id

pub fn as_slice(&self) -> &[u8]

Return the raw byte slice representing this hash

pub fn as_mut_slice(&mut self) -> &mut [u8]

Return the raw mutable byte slice representing this hash

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

Write ourselves to out in hexadecimal notation

pub const fn empty_tree() -> ObjectId

pub fn is_null(&self) -> bool

Returns true if this hash consists of all null bytes

pub const fn null_sha(kind: Kind) -> ObjectId

Returns an Digest representing a hash with whose memory is zeroed.

impl ObjectId

Sha1 hash specific methods

pub fn sha1(&self) -> &[u8; 20]

Returns ourselves as slice of 20 bytes.

Panics if this instance is not a sha1 hash.

pub fn to_sha1_hex(self) -> [u8; 40]

Return ourselves as array of 40 hexadecimal bytes.

Panics if this instance is not a sha1 hash.

pub fn to_sha1_hex_string(self) -> String

Return ourselves as hexadecimal string with a length of 40 bytes.

Panics if this instance is not a sha1 hash.

pub fn new_sha1(id: [u8; 20]) -> Self

Instantiate an Digest from 20 bytes of a Sha1 digest.

pub fn from_20_bytes(b: &[u8]) -> ObjectId

Instantiate an Digest from a slice 20 borrowed bytes of a Sha1 digest.

Panics of the slice doesn’t have a length of 20.

pub fn from_borrowed_sha1(b: &[u8; 20]) -> ObjectId

Instantiate an Digest from a borrowed array of 20 bytes of a Sha1 digest.

pub const fn null_sha1() -> ObjectId

Returns an Digest representing a Sha1 with whose memory is zeroed. TODO: remove this method replace its usage with null_sha(kind) to probably become hash independent.

impl ObjectId

Hash decoding

pub fn from_hex(buffer: &[u8]) -> Result<ObjectId, Error>

Create an instance from a buffer of 40 bytes encoded with hexadecimal notation.

Such a buffer can be obtained using write_hex_to(buffer)

Methods from Deref<Target = oid>

pub fn kind(&self) -> Kind

The kind of hash used for this Digest

pub fn first_byte(&self) -> u8

The first byte of the hash, commonly used to partition a set of Ids

pub fn as_bytes(&self) -> &[u8]

Interpret this object id as raw byte slice.

pub fn to_sha1_hex(&self) -> [u8; 40]

Returns an array with a hexadecimal encoded version of the Sha1 hash this Id represents.

Panics if this is not a Sha1 hash, as identifiable by ObjectId::kind().

pub fn sha1(&self) -> &[u8; 20]

Returns the bytes making up the Sha1.

Panics if this is not a Sha1 hash, as identifiable by ObjectId::kind().

Trait Implementations

impl AsRef<oid> for ObjectId

fn as_ref(&self) -> &oid

Performs the conversion.

impl Borrow<oid> for ObjectId

fn borrow(&self) -> &oid

Immutably borrows from an owned value.

impl Clone for ObjectId

fn clone(&self) -> ObjectId

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ObjectId

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

Formats the value using the given formatter.

impl Deref for ObjectId

type Target = oid

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<'de> Deserialize<'de> for ObjectId

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Display for ObjectId

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

Formats the value using the given formatter.

impl From<&'_ oid> for ObjectId

fn from(v: &oid) -> Self

Performs the conversion.

impl From<[u8; 20]> for ObjectId

fn from(v: [u8; 20]) -> Self

Performs the conversion.

impl FromStr for ObjectId

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for ObjectId

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 ObjectId

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

Restrict a value to a certain interval.

impl PartialEq<&'_ oid> for ObjectId

fn eq(&self, other: &&oid) -> 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 !=.

impl PartialEq<ObjectId> for &oid

fn eq(&self, other: &ObjectId) -> 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 !=.

impl PartialEq<ObjectId> for ObjectId

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

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

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

This method tests for !=.

impl PartialOrd<ObjectId> for ObjectId

fn partial_cmp(&self, other: &ObjectId) -> 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 ObjectId

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

Serialize this value into the given Serde serializer.

impl Copy for ObjectId

impl Eq for ObjectId

impl StructuralEq for ObjectId

impl StructuralPartialEq for ObjectId