Struct git2::Oid

#[repr(C)]
pub struct Oid { /* fields omitted */ }

Unique identity of any object (commit, tree, blob, tag).

Methods

impl Oid

pub fn from_str(s: &str) -> Result<Oid, Error>

Parse a hex-formatted object id into an Oid structure.

Errors

Returns an error if the string is empty, is longer than 40 hex characters, or contains any non-hex characters.

pub fn from_bytes(bytes: &[u8]) -> Result<Oid, Error>

Parse a raw object id into an Oid structure.

If the array given is not 20 bytes in length, an error is returned.

pub fn zero() -> Oid

Creates an all zero Oid structure.

pub fn hash_object(kind: ObjectType, bytes: &[u8]) -> Result<Oid, Error>

Hashes the provided data as an object of the provided type, and returns an Oid corresponding to the result. This does not store the object inside any object database or repository.

pub fn hash_file<P: AsRef<Path>>(
    kind: ObjectType,
    path: P
) -> Result<Oid, Error>

Hashes the content of the provided file as an object of the provided type, and returns an Oid corresponding to the result. This does not store the object inside any object database or repository.

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

View this OID as a byte-slice 20 bytes in length.

pub fn is_zero(&self) -> bool

Test if this OID is all zeros.

Trait Implementations

impl AsRef<[u8]> for Oid

fn as_ref(&self) -> &[u8]

Performs the conversion.

impl Eq for Oid

impl Clone for Oid

fn clone(&self) -> Oid

Returns a copy of the value.

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

Performs copy-assignment from source.

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] fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use] 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] fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use] 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 Ord for Oid

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

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

Restrict a value to a certain interval.

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

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl Copy for Oid

impl Hash for Oid

fn hash<H: Hasher>(&self, into: &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 Display for Oid

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

Hex-encode this Oid into a formatter.

impl Debug for Oid

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

Formats the value using the given formatter.

impl FromStr for Oid

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Oid, Error>

Parse a hex-formatted object id into an Oid structure.

Errors

Returns an error if the string is empty, is longer than 40 hex characters, or contains any non-hex characters.