Enum ObjectId 

#[non_exhaustive]
pub enum ObjectId {
    Sha1([u8; 20]),
    Sha256([u8; 32]),
}

An owned hash identifying objects, most commonly Sha1

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Sha1([u8; 20])

Available on crate feature sha1 only.

A SHA1 hash digest

Sha256([u8; 32])

Available on crate feature sha256 only.

A SHA256 hash digest

Implementations

impl ObjectId

Hash decoding

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

Create an instance from a buffer of 40 bytes or 64 bytes encoded with hexadecimal notation. The former will be interpreted as SHA1 while the latter will be interpreted as SHA256 when it is enabled.

Such a buffer can be obtained using oid::write_hex_to(buffer)

impl ObjectId

Access and conversion

pub fn kind(&self) -> Kind

Returns the kind of hash used in this instance.

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 const fn empty_blob(hash: Kind) -> ObjectId

The hash of an empty blob.

pub const fn empty_tree(hash: Kind) -> ObjectId

The hash of an empty tree.

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

Returns an instances whose bytes are all zero.

pub fn is_null(&self) -> bool

Returns true if this hash consists of all null bytes.

pub fn is_empty_blob(&self) -> bool

Returns true if this hash is equal to an empty blob.

pub fn is_empty_tree(&self) -> bool

Returns true if this hash is equal to an empty tree.

impl ObjectId

Lifecycle

pub fn from_bytes_or_panic(bytes: &[u8]) -> Self

Convert bytes into an owned object Id or panic if the slice length doesn’t indicate a supported hash.

Use Self::try_from(bytes) for a fallible version.

Methods from Deref<Target = oid>

pub fn kind(&self) -> Kind

The kind of hash used for this instance.

pub fn first_byte(&self) -> u8

The first byte of the hash, commonly used to partition a set of object ids.

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

Interpret this object id as raw byte slice.

pub fn to_hex_with_len(&self, len: usize) -> HexDisplay<'_>

Return a type which can display itself in hexadecimal form with the len amount of characters.

pub fn to_hex(&self) -> HexDisplay<'_>

Return a type which displays this oid as hex in full.

pub fn to_prefix(&self, range: Range<usize>) -> Prefix

Return the bytes in range as a standalone, byte-aligned Prefix.

The range addresses raw hash bytes, not hexadecimal digits. Thus, each selected byte contributes two hexadecimal digits to the returned prefix. The selected bytes become the beginning of the prefix, independently of where they occurred in this object ID.

Panics

If range is out of bounds or has its start after its end.

pub fn hex_to_buf<'a>(&self, buf: &'a mut [u8]) -> &'a mut str

Write ourselves to the out in hexadecimal notation, returning the hex-string ready for display.

Panics

If the buffer isn’t big enough to hold twice as many bytes as the current binary size.

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

Write ourselves to out in hexadecimal notation.

pub fn is_null(&self) -> bool

Returns true if this hash consists of all null bytes.

pub fn is_empty_blob(&self) -> bool

Returns true if this hash is equal to an empty blob.

pub fn is_empty_tree(&self) -> bool

Returns true if this hash is equal to an empty tree.

pub fn verify(&self, expected: &oid) -> Result<(), Error>

Verify that self matches the expected object ID.

Returns an Error containing both object IDs if they differ.

Trait Implementations

impl AsRef<oid> for ObjectId

fn as_ref(&self) -> &oid

Converts this type into a shared reference of the (usually inferred) input type.

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 duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for ObjectId

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

Available on crate feature serde only.

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 Eq for ObjectId

impl From<&oid> for ObjectId

fn from(v: &oid) -> Self

Converts to this type from the input type.

impl From<ChangeId> for ObjectId

fn from(value: ChangeId) -> Self

Converts to this type from the input type.

impl From<ObjectId> for ChangeId

fn from(value: ObjectId) -> Self

Converts to this type from the input type.

impl From<ObjectId> for Prefix

fn from(oid: ObjectId) -> Self

Converts to this type from the input type.

impl From<[u8; 20]> for ObjectId

Available on crate feature sha1 only.

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

Converts to this type from the input type.

impl From<[u8; 32]> for ObjectId

Available on crate feature sha256 only.

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

Converts to this type from the input type.

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, Self: Sized,

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

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,

Restrict a value to a certain interval.

impl PartialEq for ObjectId

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

Equality operator ==.

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

Inequality operator !=.

impl PartialEq<&BStr> for ObjectId

Available on crate feature bstr only.

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

Equality operator ==.

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

Inequality operator !=.

impl PartialEq<&oid> for ObjectId

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

Equality operator ==.

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

Inequality operator !=.

impl PartialEq<&str> for ObjectId

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

Equality operator ==.

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

Inequality operator !=.

impl PartialEq<BStr> for ObjectId

Available on crate feature bstr only.

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

Equality operator ==.

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

Inequality operator !=.

impl PartialEq<BString> for ObjectId

Available on crate feature bstr only.

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

Equality operator ==.

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

Inequality operator !=.

impl PartialEq<ObjectId> for &oid

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

Equality operator ==.

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

Inequality operator !=.

impl PartialEq<ObjectId> for str

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

Equality operator ==.

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

Inequality operator !=.

impl PartialEq<ObjectId> for &str

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

Equality operator ==.

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

Inequality operator !=.

impl PartialEq<ObjectId> for String

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

Equality operator ==.

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

Inequality operator !=.

impl PartialEq<ObjectId> for BStr

Available on crate feature bstr only.

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

Equality operator ==.

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

Inequality operator !=.

impl PartialEq<ObjectId> for &BStr

Available on crate feature bstr only.

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

Equality operator ==.

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

Inequality operator !=.

impl PartialEq<ObjectId> for BString

Available on crate feature bstr only.

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

Equality operator ==.

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

Inequality operator !=.

impl PartialEq<String> for ObjectId

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

Equality operator ==.

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

Inequality operator !=.

impl PartialEq<str> for ObjectId

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd 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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl Serialize for ObjectId

Available on crate feature serde only.

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ObjectId

impl TryFrom<&[u8]> for ObjectId

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.