Struct gix_revision::describe::Outcome

pub struct Outcome<'name> {
    pub name: Option<Cow<'name, BStr>>,
    pub id: ObjectId,
    pub depth: u32,
    pub name_by_oid: HashMap<ObjectId, Cow<'name, BStr>>,
    pub commits_seen: u32,
}

Available on crate feature describe only.

The positive result produced by describe().

Fields

name: Option<Cow<'name, BStr>>

The name of the tag or branch that is closest to the commit id.

If None, no name was found but it was requested to provide the id itself as fallback.

id: ObjectId

The input commit object id that we describe.

depth: u32

The number of commits that are between the tag or branch with name and id. These commits are all in the future of the named tag or branch.

name_by_oid: HashMap<ObjectId, Cow<'name, BStr>>

The mapping between object ids and their names initially provided by the describe call.

commits_seen: u32

The amount of commits we traversed.

Implementations

impl<'a> Outcome<'a>

pub fn into_format(self, hex_len: usize) -> Format<'a>

Turn this outcome into a structure that can display itself in the typical git describe format.

Trait Implementations

impl<'name> Clone for Outcome<'name>

fn clone(&self) -> Outcome<'name>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'name> Debug for Outcome<'name>

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

Formats the value using the given formatter.