Struct gix::Id

pub struct Id<'r> { /* private fields */ }

An ObjectId with access to a repository.

Implementations

impl<'repo> Id<'repo>

An object id infused with a Repository.

pub fn object(&self) -> Result<Object<'repo>, Error>

Find the Object associated with this object id, and consider it an error if it doesn’t exist.

Note

There can only be one ObjectRef per Easy. To increase that limit, clone the Easy.

pub fn header(&self) -> Result<Header, Error>

Find the header associated with this object id, or an error if it doesn’t exist.

Use this method if there is no interest in the contents of the object, which generally is much faster to obtain.

pub fn try_object(&self) -> Result<Option<Object<'repo>>, Error>

Try to find the Object associated with this object id, and return None if it’s not available locally.

Note

There can only be one ObjectRef per Easy. To increase that limit, clone the Easy.

pub fn try_header(&self) -> Result<Option<Header>, Error>

Find the header associated with this object id, or return None if it doesn’t exist.

Use this method if there is no interest in the contents of the object, which generally is much faster to obtain.

pub fn shorten(&self) -> Result<Prefix, Error>

Turn this object id into a shortened id with a length in hex as configured by core.abbrev.

pub fn shorten_or_id(&self) -> Prefix

Turn this object id into a shortened id with a length in hex as configured by core.abbrev, or default to a prefix which equals our id in the unlikely error case.

impl<'repo> Id<'repo>

pub fn detach(self) -> ObjectId

Turn this instance into its bare ObjectId.

impl<'repo> Id<'repo>

pub fn ancestors(&self) -> Platform<'repo>

Obtain a platform for traversing ancestors of this commit.

Methods from Deref<Target = oid>

pub fn kind(&self) -> Kind

Available on crate feature excludes only.

The kind of hash used for this instance.

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.

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

Available on crate feature excludes only.

Interpret this object id as raw byte slice.

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.

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

Available on crate feature excludes only.

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

pub fn is_null(&self) -> bool

Available on crate feature excludes only.

Returns true if this hash consists of all null bytes.

pub fn hex_to_buf(&self, buf: &mut [u8]) -> usize

Available on crate feature excludes only.

Write ourselves to the out in hexadecimal notation, returning the amount of written bytes.

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>

Available on crate feature excludes only.

Write ourselves to out in hexadecimal notation.

Trait Implementations

impl<'repo> AsRef<oid> for Id<'repo>

fn as_ref(&self) -> &oid

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

impl<'r> Clone for Id<'r>

fn clone(&self) -> Id<'r>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'repo> Debug for Id<'repo>

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

Formats the value using the given formatter.

impl<'repo> Deref for Id<'repo>

type Target = oid

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<'repo> Display for Id<'repo>

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

Formats the value using the given formatter.

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

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

Converts to this type from the input type.

impl<'a> Hash for Id<'a>

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<'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<'repo> PartialEq<Object<'repo>> for Id<'repo>

fn eq(&self, other: &Object<'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<'repo> PartialEq<ObjectDetached> for Id<'repo>

fn eq(&self, other: &ObjectDetached) -> 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<ObjectId> for Id<'repo>

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<'repo> PartialEq<oid> for Id<'repo>

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 for Id<'repo>

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<'a> PartialOrd for Id<'a>

fn partial_cmp(&self, other: &Id<'a>) -> 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<'r> Copy for Id<'r>