gix_ref

Struct Reference

source
pub struct Reference {
    pub name: FullName,
    pub target: Target,
    pub peeled: Option<ObjectId>,
}
Expand description

A fully owned backend agnostic reference

Fields§

§name: FullName

The path to uniquely identify this ref within its store.

§target: Target

The target of the reference, either a symbolic reference by full name or a possibly intermediate object by its id.

§peeled: Option<ObjectId>

The fully peeled object to which this reference ultimately points to after following all symbolic refs and all annotated tags. Only guaranteed to be set after Reference::peel_to_id_in_place() was called or if this reference originated from a packed ref.

Implementations§

source§

impl Reference

source

pub fn kind(&self) -> Kind

Returns the kind of reference based on its target

source

pub fn name_without_namespace( &self, namespace: &Namespace, ) -> Option<&FullNameRef>

Return the full validated name of the reference, with the given namespace stripped if possible.

If the reference name wasn’t prefixed with namespace, None is returned instead.

source

pub fn strip_namespace(&mut self, namespace: &Namespace) -> &mut Self

Strip the given namespace from our name as well as the name, but not the reference we point to.

Trait Implementations§

source§

impl Clone for Reference

source§

fn clone(&self) -> Reference

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 Reference

source§

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

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

impl<'de> Deserialize<'de> for Reference

source§

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

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

impl<'p> From<Reference<'p>> for Reference

source§

fn from(value: Reference<'p>) -> Self

Converts to this type from the input type.
source§

impl From<Reference> for Reference

source§

fn from(value: Reference) -> Self

Converts to this type from the input type.
source§

impl From<Reference> for Reference

source§

fn from(value: Reference) -> Self

Converts to this type from the input type.
source§

impl Hash for Reference

source§

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

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 Ord for Reference

source§

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

source§

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

source§

fn partial_cmp(&self, other: &Reference) -> 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 ReferenceExt for Reference

source§

fn log_iter<'a, 's>(&'a self, store: &'s Store) -> Platform<'a, 's>

A step towards obtaining forward or reverse iterators on reference logs.
source§

fn log_exists(&self, store: &Store) -> bool

For details, see Reference::log_exists().
source§

fn peel_to_id_in_place( &mut self, store: &Store, objects: &dyn Find, ) -> Result<ObjectId, Error>

Follow all symbolic targets this reference might point to and peel the underlying object to the end of the tag-chain, returning the first non-tag object the annotated tag points to, using objects to access them and store to lookup symbolic references. Read more
source§

fn peel_to_id_in_place_packed( &mut self, store: &Store, objects: &dyn Find, packed: Option<&Buffer>, ) -> Result<ObjectId, Error>

Like ReferenceExt::peel_to_id_in_place(), but with support for a known stable packed buffer to use for resolving symbolic links.
source§

fn follow_to_object_in_place_packed( &mut self, store: &Store, packed: Option<&Buffer>, ) -> Result<ObjectId, Error>

Like ReferenceExt::follow(), but follows all symbolic references while gracefully handling loops, altering this instance in place.
source§

fn follow(&self, store: &Store) -> Option<Result<Reference, Error>>

Follow this symbolic reference one level and return the ref it refers to. Read more
source§

fn follow_packed( &self, store: &Store, packed: Option<&Buffer>, ) -> Option<Result<Reference, Error>>

Follow this symbolic reference one level and return the ref it refers to, possibly providing access to packed references for lookup if it contains the referent. Read more
source§

impl Serialize for Reference

source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
source§

impl Eq for Reference

source§

impl StructuralPartialEq for Reference

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, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. 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<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, 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>,