[go: up one dir, main page]
gix

Enum ObjectId

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

An owned hash identifying objects, most commonly Sha1

Variants§

§

Sha1([u8; 20])

A SHA 1 hash digest

Implementations§

Source§

impl ObjectId

Hash decoding

Source

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

Available on crate feature excludes only.

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)

Source§

impl ObjectId

Access and conversion

Source

pub fn kind(&self) -> Kind

Available on crate feature excludes only.

Returns the kind of hash used in this instance.

Source

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

Available on crate feature excludes only.

Return the raw byte slice representing this hash.

Source

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

Available on crate feature excludes only.

Return the raw mutable byte slice representing this hash.

Source

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

Available on crate feature excludes only.

The hash of an empty blob.

Source

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

Available on crate feature excludes only.

The hash of an empty tree.

Source

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

Available on crate feature excludes only.

Returns an instances whose bytes are all zero.

Source

pub fn is_null(&self) -> bool

Available on crate feature excludes only.

Returns true if this hash consists of all null bytes.

Source

pub fn is_empty_blob(&self) -> bool

Available on crate feature excludes only.

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

Source

pub fn is_empty_tree(&self) -> bool

Available on crate feature excludes only.

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

Source§

impl ObjectId

Lifecycle

Source

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

Available on crate feature excludes only.

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.

Source§

impl ObjectId

Sha1 hash specific methods

This impl block contains no items.

Methods from Deref<Target = oid>§

Source

pub fn kind(&self) -> Kind

Available on crate feature excludes only.

The kind of hash used for this instance.

Source

pub fn first_byte(&self) -> u8

Available on crate feature excludes only.

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

Source

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

Available on crate feature excludes only.

Interpret this object id as raw byte slice.

Source

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

Available on crate feature excludes only.

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

Source

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

Available on crate feature excludes only.

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

Source

pub fn is_null(&self) -> bool

Available on crate feature excludes only.

Returns true if this hash consists of all null bytes.

Source

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

Available on crate feature excludes only.

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.

Source

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

Available on crate feature excludes only.

Write ourselves to out in hexadecimal notation.

Source

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

Available on crate feature excludes only.

Verify that self matches the expected object ID.

Returns an Error containing both object IDs if they differ.

Trait Implementations§

Source§

impl AsRef<oid> for ObjectId

Source§

fn as_ref(&self) -> &oid

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

impl Borrow<oid> for ObjectId

Source§

fn borrow(&self) -> &oid

Immutably borrows from an owned value. Read more
Source§

impl Clone for ObjectId

Source§

fn clone(&self) -> ObjectId

Returns a copy of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ObjectId

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Deref for ObjectId

Source§

type Target = oid

The resulting type after dereferencing.
Source§

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

Dereferences the value.
Source§

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

Source§

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

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Display for ObjectId

Source§

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

Formats the value using the given formatter. Read more
Source§

impl From<&oid> for ObjectId

Source§

fn from(v: &oid) -> ObjectId

Converts to this type from the input type.
Source§

impl From<[u8; 20]> for ObjectId

Source§

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

Converts to this type from the input type.
Source§

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

Source§

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

Converts to this type from the input type.
Source§

impl From<ObjectId> for Prefix

Source§

fn from(oid: ObjectId) -> Prefix

Converts to this type from the input type.
Source§

impl FromStr for ObjectId

Source§

type Err = Error

The associated error which can be returned from parsing.
Source§

fn from_str(s: &str) -> Result<ObjectId, <ObjectId as FromStr>::Err>

Parses a string s to return a value of this type. Read more
Source§

impl Hash for ObjectId

Source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl ObjectIdExt for ObjectId

Source§

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.
Source§

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

Infuse this object id repo access.
Source§

impl Ord for ObjectId

Source§

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

This method returns an Ordering between self and other. Read more
1.21.0 · Source§

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

Compares and returns the maximum of two values. Read more
1.21.0 · Source§

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

Compares and returns the minimum of two values. Read more
1.50.0 · Source§

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

Restrict a value to a certain interval. Read more
Source§

impl PartialEq<&oid> for ObjectId

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

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

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl PartialEq<ObjectId> for &oid

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl PartialEq<ObjectId> for Id<'_>

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl PartialEq for ObjectId

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl PartialOrd for ObjectId

Source§

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

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · Source§

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

Tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · Source§

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

Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · Source§

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

Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · Source§

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

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

impl Serialize for ObjectId

Source§

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. Read more
Source§

impl TryFrom<&[u8]> for ObjectId

Source§

type Error = Error

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

impl TryFrom<Target> for ObjectId

Source§

type Error = Target

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

impl Copy for ObjectId

Source§

impl Eq for ObjectId

Source§

impl StructuralPartialEq for ObjectId

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<P, T> Receiver for P
where P: Deref<Target = T> + ?Sized, T: ?Sized,

Source§

type Target = T

🔬This is a nightly-only experimental API. (arbitrary_self_types)
The target type on which the method may be called.
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> ErasedDestructor for T
where T: 'static,

Source§

impl<T> MaybeSendSync for T