Struct ObjectId 

pub struct ObjectId { /* private fields */ }

A Git object identifier: a SHA-1 (20-byte) or SHA-256 (32-byte) digest.

The digest is stored in a fixed 32-byte buffer with an explicit length; bytes beyond len are always zero, so the derived Eq/Ord/Hash remain correct. The hash algorithm is inferred from the length.

Examples

use grit_lib::objects::ObjectId;

let id = ObjectId::from_hex("4b825dc642cb6eb9a060e54bf8d69288fbee4904")?;
assert_eq!(id.to_hex(), "4b825dc642cb6eb9a060e54bf8d69288fbee4904");

Implementations

impl ObjectId

pub const fn zero() -> Self

The all-zero SHA-1 object id (Git’s “null” OID).

Used for index placeholders such as intent-to-add entries and for special cases in plumbing output. For an algorithm-specific null OID (e.g. 64 zeros in a SHA-256 repo) use ObjectId::null.

pub const fn null(algo: HashAlgo) -> Self

The all-zero (“null”) object id for a given hash algorithm.

pub fn from_bytes(bytes: &[u8]) -> Result<Self>

Construct from a raw digest slice (20 bytes for SHA-1, 32 for SHA-256).

Errors

Returns Error::InvalidObjectId when bytes is not a recognised digest length.

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

Raw digest bytes (20 or 32 bytes depending on the hash algorithm).

pub fn algo(&self) -> HashAlgo

The hash algorithm this OID belongs to.

pub fn is_zero(&self) -> bool

Check if this is the null (all-zero) object ID.

pub const fn empty_tree() -> Self

Canonical SHA-1 empty tree object id (4b825dc642cb6eb9a060e54bf8d69288fbee4904).

Returns the well-known digest without writing a loose object. On SHA-256 repositories use Odb::empty_tree_oid instead.

pub fn to_hex(&self) -> String

Lowercase hex representation (40 or 64 characters).

pub fn loose_prefix(&self) -> String

The two-character directory prefix used by the loose object store.

Returns the first two hex chars (e.g. "ab" for "ab3f…").

pub fn from_hex(s: &str) -> Result<Self>

Parse an object ID from a hex string (40 chars for SHA-1, 64 for SHA-256).

Errors

Returns Error::InvalidObjectId if the string is not a valid hex OID.

pub fn from_hex_ascii(bytes: &[u8]) -> Result<Self>

Parse a fixed-width lowercase/uppercase ASCII hex OID (40 chars for SHA-1).

Errors

Returns Error::InvalidObjectId when bytes is not exactly 40 hex digits.

pub fn loose_suffix(&self) -> String

The suffix used as the filename inside the loose prefix dir (the digest minus its first byte: 38 hex chars for SHA-1, 62 for SHA-256).

pub fn is_full_hex(s: &str) -> bool

Whether s is a full-length hex OID for a supported hash algorithm (40 hex chars for SHA-1 or 64 for SHA-256), case-insensitive.

pub const fn is_hex_len(len: usize) -> bool

Whether len is a valid full hex-OID length (40 or 64).

pub const fn is_loose_suffix_len(len: usize) -> bool

Whether len is a valid loose-object filename suffix length, i.e. a full hex OID minus its first byte (38 for SHA-1, 62 for SHA-256).

Trait Implementations

impl Clone for ObjectId

fn clone(&self) -> Self

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

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

Formats the value using the given formatter.

impl Eq for ObjectId

impl FromStr for ObjectId

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self>

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: &Self) -> 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.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

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

Restrict a value to a certain range.

impl PartialEq for ObjectId

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for ObjectId

fn partial_cmp(&self, other: &Self) -> 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 StructuralPartialEq for ObjectId