Struct git_hash::oid

#[repr(transparent)]
pub struct oid { /* fields omitted */ }

A borrowed reference to a hash identifying objects.

Future Proofing

In case we wish to support multiple hashes with the same length we cannot discriminate using the slice length anymore. To make that work, we will use the high bits of the internal bytes slice length (a fat pointer, pointing to data and its length in bytes) to encode additinoal information. Before accessing or returning the bytes, a new adjusted slice will be constructed, while the high bits will be used to help resolving the hash [kind()][oid::kind()]. We expect to have quite a few bits available for such ‘conflict resolution’ as most hashes aren’t longer than 64 bytes.

Implementations

impl oid

Conversion

pub fn try_from(value: &[u8]) -> Result<&Self, Error>

impl oid

Access

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]

impl oid

Sha1 specific methods

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().

pub fn null_sha1() -> &'static Self

Returns a Sha1 digest with all bytes being initialized to zero.

Trait Implementations

impl AsRef<oid> for &oid

fn as_ref(&self) -> &oid

Performs the conversion.

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 Debug for oid

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

Formats the value using the given formatter.

impl<'de: 'a, 'a> Deserialize<'de> for &'a oid

Manually created from a version that uses a slice, and we forcefully try to convert it into a borrowed array of the desired size Could be improved by fitting this into serde Unfortunately the serde::Deserialize derive wouldn’t work for borrowed arrays.

fn deserialize<D>(
    deserializer: D
) -> Result<Self, <D as Deserializer<'de>>::Error> where
    D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Display for &oid

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

Formats the value using the given formatter.

impl Eq for oid

impl From<&'_ oid> for ObjectId

fn from(v: &oid) -> Self

Performs the conversion.

impl<'a> From<&'a [u8; 20]> for &'a oid

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

Performs the conversion.

impl Hash for oid

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

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

#[must_use]

pub 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 ==.

#[must_use]

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

This method tests for !=.

impl PartialEq<oid> for oid

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: &oid) -> bool

This method tests for !=.

impl PartialOrd<oid> for oid

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

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

Serialize this value into the given Serde serializer.

impl StructuralEq for oid

impl StructuralPartialEq for oid

impl ToOwned for oid

type Owned = ObjectId

The resulting type after obtaining ownership.

fn to_owned(&self) -> Self::Owned

Creates owned data from borrowed data, usually by cloning.

pub fn clone_into(&self, target: &mut Self::Owned)

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

recently added

Uses borrowed data to replace owned data, usually by cloning.