gix_revision::describe

Struct Outcome

source
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.
Expand description

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§

source§

impl<'a> Outcome<'a>

source

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§

source§

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

source§

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

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<'name> Debug for Outcome<'name>

source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<'name> Freeze for Outcome<'name>

§

impl<'name> RefUnwindSafe for Outcome<'name>

§

impl<'name> Send for Outcome<'name>

§

impl<'name> Sync for Outcome<'name>

§

impl<'name> Unpin for Outcome<'name>

§

impl<'name> UnwindSafe for Outcome<'name>

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.