Struct git_ref::file::loose::Reference

pub struct Reference {
    pub name: FullName,
    pub target: Target,
}

A git ref which is stored in a file.

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 an object by its id.

Implementations

impl Reference

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

Returns true if a reflog exists in the given store.

Please note that this method shouldn’t be used to check if a log exists before trying to read it, but instead is meant to be the fastest possible way to determine if a log exists or not. If the caller needs to know if it’s readable, try to read the log instead with a reverse or forward iterator.

pub fn log_iter_rev<'b>(
    &self,
    store: &Store,
    buf: &'b mut [u8]
) -> Result<Option<Reverse<'b, File>>>

Return a reflog reverse iterator for this ref, reading chunks from the back into the fixed buffer buf, in the given store.

The iterator will traverse log entries from most recent to oldest, reading the underlying file in chunks from the back. Return Ok(None) if no reflog exists.

pub fn log_iter<'a, 'b: 'a>(
    &'a self,
    store: &Store,
    buf: &'b mut Vec<u8>
) -> Result<Option<impl Iterator<Item = Result<Line<'b>, Error>> + 'a>>

Return a reflog forward iterator for this ref and write its file contents into buf, in the given store.

The iterator will traverse log entries from oldest to newest. Return Ok(None) if no reflog exists.

impl Reference

pub fn peel_to_id_in_place<E: Error + Send + Sync + 'static>(
    &mut self,
    store: &Store,
    packed: Option<&Buffer>,
    find: impl FnMut(ObjectId, &mut Vec<u8>) -> Result<Option<(Kind, &[u8])>, E>
) -> Result<&oid, Error>

Follow this symbolic reference until the end of the chain is reached and an object ID is available, and possibly peel this object until the final target object is revealed.

Use peel::none()

If an error occurs this reference remains unchanged.

impl Reference

pub fn follow_symbolic<'p>(
    &self,
    store: &Store,
    packed: Option<&'p Buffer>
) -> Option<Result<Reference<'p>, Error>>

Follow this symbolic reference one level and return the ref it refers to, possibly providing access to packed references for lookup.

Returns None if this is not a symbolic reference, hence the leaf of the chain.

impl Reference

pub fn try_from_path(
    name: FullName,
    path_contents: &[u8]
) -> Result<Self, Error>

Create a new reference of the given parent store with relative_path service as unique identifier at which the path_contents was read to obtain the refs value.

impl Reference

pub fn kind(&self) -> Kind

Return the kind of ref.

Trait Implementations

impl Clone for Reference

fn clone(&self) -> Reference

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Reference

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

Formats the value using the given formatter.

impl Hash for Reference

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, 

Feeds a slice of this type into the given Hasher.

impl Ord for Reference

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

Restrict a value to a certain interval.

impl PartialEq<Reference> for Reference

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl PartialOrd<Reference> for Reference

fn partial_cmp(&self, other: &Reference) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

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

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

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

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

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

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<'p> TryFrom<Reference<'p>> for Reference

type Error = ()

The type returned in the event of a conversion error.

fn try_from(value: Reference<'p>) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for Reference

impl StructuralEq for Reference

impl StructuralPartialEq for Reference