Struct git_repository::revision::Spec

pub struct Spec<'repo> { /* private fields */ }

The specification of a revision as parsed from a revision specification like HEAD@{1} or v1.2.3...main. It’s typically created by repo.rev_parse().

See the official git documentation for reference on how to specify revisions and revision ranges.

Implementations

impl<'repo> Spec<'repo>

pub fn from_bstr<'a>(
    spec: impl Into<&'a BStr>,
    repo: &'repo Repository,
    opts: Options
) -> Result<Self, Error>

Parse spec and use information from repo to resolve it, using opts to learn how to deal with ambiguity.

Note that it’s easier and to use repo.rev_parse() instead.

impl<'repo> Spec<'repo>

Initialization

pub fn from_id(id: Id<'repo>) -> Self

Create a single specification which points to id.

impl<'repo> Spec<'repo>

Access

pub fn detach(self) -> Spec

Detach the Repository from this instance, leaving only plain data that can be moved freely and serialized.

pub fn into_references(
    self
) -> (Option<Reference<'repo>>, Option<Reference<'repo>>)

Some revision specifications leave information about references which are returned as (from-ref, to-ref) here, e.g. HEAD@{-1}..main might be (Some(refs/heads/previous-branch), Some(refs/heads/main)), or @ returns (Some(refs/heads/main), None).

pub fn first_reference(&self) -> Option<&Reference>

Return the name of the first reference we encountered while resolving the rev-spec, or None if a short hash was used. For example, @ might yield Some(HEAD), but abcd yields None.

pub fn second_reference(&self) -> Option<&Reference>

Return the name of the second reference we encountered while resolving the rev-spec, or None if a short hash was used or there was no second reference. For example, ..@ might yield Some(HEAD), but ..abcd or @ yields None.

pub fn single(&self) -> Option<Id<'repo>>

Return the single included object represented by this instance, or None if it is a range of any kind.

Methods from Deref<Target = Spec>

pub fn kind(&self) -> Kind

Return the kind of this specification.

Trait Implementations

impl<'repo> Clone for Spec<'repo>

fn clone(&self) -> Spec<'repo>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'repo> Debug for Spec<'repo>

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

Formats the value using the given formatter.

impl<'repo> Deref for Spec<'repo>

type Target = Spec

The resulting type after dereferencing.

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

Dereferences the value.

impl<'repo> DerefMut for Spec<'repo>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<'repo> PartialEq<Spec<'repo>> for Spec<'repo>

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'repo> Eq for Spec<'repo>