Enum ObjectId

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

Available on crate features async-client or blocking-client only.

An owned hash identifying objects, most commonly Sha1

Variants

Sha1([u8; 20])

A SHA 1 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 encoded with hexadecimal notation.

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]) -> ObjectId

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.

impl ObjectId

Sha1 hash specific methods

This impl block contains no items.

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 is_null(&self) -> bool

Returns true if this hash consists of all null bytes.

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<(), Error>

Write ourselves to out in hexadecimal notation.

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 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<(), Error>

Formats the value using the given formatter.

impl Deref for ObjectId

type Target = oid

The resulting type after dereferencing.

fn deref(&self) -> &<ObjectId as Deref>::Target

Dereferences the value.

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

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for ObjectId

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

Formats the value using the given formatter.

impl From<&oid> for ObjectId

fn from(v: &oid) -> ObjectId

Converts to this type from the input type.

impl From<[u8; 20]> for ObjectId

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

Converts to this type from the input type.

impl<'repo> From<Id<'repo>> for ObjectId

fn from(v: Id<'repo>) -> ObjectId

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<ObjectId, <ObjectId as FromStr>::Err>

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

impl Hash for ObjectId

fn hash<H>(&self, state: &mut H)

where H: Hasher,

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

fn ancestors<Find>(self, find: Find) -> Simple<Find, fn(_: &oid) -> bool>

where Find: Find,

Create an iterator over the ancestry of the commits reachable from this id, which must be a commit.

fn attach(self, repo: &Repository) -> Id<'_>

Infuse this object id repo access.

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<&oid> for ObjectId

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'repo> PartialEq<Id<'repo>> for ObjectId

fn eq(&self, other: &Id<'repo>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<ObjectId> for &oid

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq for ObjectId

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<&[u8]> for ObjectId

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<Target> for ObjectId

type Error = Target

The type returned in the event of a conversion error.

fn try_from( value: Target, ) -> Result<ObjectId, <ObjectId as TryFrom<Target>>::Error>

Performs the conversion.

impl Copy for ObjectId

impl Eq for ObjectId

impl StructuralPartialEq for ObjectId