Enum git_ref::file::Reference

pub enum Reference<'p> {
    Packed(Reference<'p>),
    Loose(Reference),
}

Either a loose or packed reference, depending on where it was found.

Variants

Packed

A reference originating in a pack

Tuple Fields of Packed

0: Reference<'p>

Loose

A reference from the filesystem

Tuple Fields of Loose

0: Reference

Implementations

impl<'p> Reference<'p>

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

For details, see loose::Reference::log_exists().

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<ObjectId, Error>

For details, see crate::file::loose::Reference::peel_to_id_in_place.

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

For details, see crate::file::loose::Reference::follow_symbolic().

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

Obtain a reverse iterator over logs of this reference. See crate::file::loose::Reference::log_iter_rev() for details.

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

Obtain an iterator over logs of this reference. See crate::file::loose::Reference::log_iter() for details.

pub fn kind(&self) -> Kind

Returns the kind of reference

pub fn into_target(self) -> Target

Transform this reference into an owned Target

pub fn is_packed(&self) -> bool

Returns true if this ref is located in a packed ref buffer.

pub fn name(&self) -> FullNameRef<'_>

Return the full validated name of the reference, which may include a namespace.

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.

pub fn target(&self) -> Target

Return the target to which the reference points to.

Trait Implementations

impl<'p> Debug for Reference<'p>

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

Formats the value using the given formatter.

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

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.