Struct Oid 

pub struct Oid { /* private fields */ }

Available on crate feature git2 only.

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

Implementations

impl Oid

pub const ZERO_SHA1: Oid

An all-zero SHA1 OID.

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

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

This always parses as SHA1 (up to 40 hex characters). Use Oid::from_str_ext to parse with a specific format.

Errors

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

pub fn from_str_ext(s: &str, format: ObjectFormat) -> Result<Oid, Error>

Parses a hex-formatted object id with a specific object format.

Errors

Returns an error if the string is

• is empty
• is longer than 40 hex with SHA1 object format
• is longer than 64 hex with SHA256 object format
• 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

👎Deprecated since 0.21.0:

use Oid::ZERO_SHA1 instead

Creates an all-zero SHA1 OID.

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.

This always hashes using SHA1. Use Oid::hash_object_ext to hash with a specific format.

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

Hashes the provided data as an object of the provided type, with a specific object format.

See Oid::hash_object for more details.

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

where P: AsRef<Path>,

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.

This always hashes using SHA1. Use Oid::hash_file_ext to hash with a specific format.

pub fn hash_file_ext<P>( kind: ObjectType, path: P, format: ObjectFormat, ) -> Result<Oid, Error>

where P: AsRef<Path>,

Hashes the content of a file as an object of the provided type, with a specific object format.

See Oid::hash_file for more details.

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

View this OID as a byte-slice in its logical length: 20 bytes for SHA1, 32 bytes for SHA256.

pub fn is_zero(&self) -> bool

Test if this OID is all zeros.

pub fn object_format(&self) -> ObjectFormat

Returns the ObjectFormat of this OID.

Without the unstable-sha256 feature, this always returns ObjectFormat::Sha1.

Trait Implementations

impl AsRef<[u8]> for Oid

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

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

impl Binding for Oid

type Raw = *const git_oid

The raw type that allows you to interact with libgit2-sys.

unsafe fn from_raw(oid: *const git_oid) -> Oid

Build a git2 struct from its Binding::Raw value.

fn raw(&self) -> *const git_oid

Access the Binding::Raw value for a struct.

unsafe fn from_raw_opt<T>(raw: T) -> Option<Self>

where T: Copy + IsNull, Self: Binding<Raw = T>,

A null-handling version of Binding::from_raw.

impl Clone for Oid

fn clone(&self) -> Oid

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Oid

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

Formats the value using the given formatter.

impl<'r, DB> Decode<'r, DB> for Oid

where DB: Database, &'r [u8]: Decode<'r, DB>,

fn decode( value: <DB as HasValueRef<'r>>::ValueRef, ) -> Result<Oid, Box<dyn Error + Sync + Send>>

Decode a new value of this type using a raw value from the database.

impl Display for Oid

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

Hex-encode this Oid into a formatter.

impl<'q, DB> Encode<'q, DB> for Oid

where DB: Database, Vec<u8>: Encode<'q, DB>,

fn encode_by_ref( &self, buf: &mut <DB as HasArguments<'q>>::ArgumentBuffer, ) -> IsNull

Writes the value of self into buf without moving self.

fn encode(self, buf: &mut <DB as HasArguments<'q>>::ArgumentBuffer) -> IsNull

where Self: Sized,

Writes the value of self into buf in the expected format for the database.

fn produces(&self) -> Option<<DB as Database>::TypeInfo>

fn size_hint(&self) -> usize

impl FromStr for Oid

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

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

This always parses as SHA1. Use Oid::from_str_ext for format-aware parsing.

Errors

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

type Err = Error

The associated error which can be returned from parsing.

impl Hash for Oid

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

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

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 PartialOrd for Oid

fn partial_cmp(&self, other: &Oid) -> 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<DB> Type<DB> for Oid

where DB: Database, [u8]: Type<DB>,

fn type_info() -> <DB as Database>::TypeInfo

Returns the canonical SQL type for this Rust type.

fn compatible(ty: &<DB as Database>::TypeInfo) -> bool

Determines if this Rust type is compatible with the given SQL type.

impl Copy for Oid

impl Eq for Oid