Struct gix_revision::describe::Format

pub struct Format<'a> {
    pub name: Option<Cow<'a, BStr>>,
    pub id: ObjectId,
    pub hex_len: usize,
    pub depth: u32,
    pub long: bool,
    pub dirty_suffix: Option<String>,
}

Available on crate feature describe only.

A structure implementing Display, producing a git describe like string.

Fields

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

The name of the branch or tag to display, as is.

If None, the id will be displayed as a fallback.

id: ObjectId

The id of the commit to describe.

hex_len: usize

The amount of hex characters to use to display id.

depth: u32

The amount of commits between name and id, where id is in the future of name.

long: bool

If true, the long form of the describe string will be produced even if id lies directly on name, hence has a depth of 0.

dirty_suffix: Option<String>

If Some(suffix), it will be appended to the describe string. This should be set if the working tree was determined to be dirty.

Implementations

impl<'a> Format<'a>

pub fn is_exact_match(&self) -> bool

Return true if the name is directly associated with id, i.e. there are no commits between them.

pub fn long(&mut self, long: bool) -> &mut Self

Set this instance to print in long mode, that is if depth is 0, it will still print the whole long form even though it’s not quite necessary.

Otherwise, it is allowed to shorten itself.

Trait Implementations

impl<'a> Clone for Format<'a>

fn clone(&self) -> Format<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Format<'a>

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

Formats the value using the given formatter.

impl<'a> Display for Format<'a>

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

Formats the value using the given formatter.

impl<'a> Hash for Format<'a>

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<'a> Ord for Format<'a>

fn cmp(&self, other: &Format<'a>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl<'a> PartialEq for Format<'a>

fn eq(&self, other: &Format<'a>) -> 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<'a> PartialOrd for Format<'a>

fn partial_cmp(&self, other: &Format<'a>) -> 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<'a> Eq for Format<'a>

impl<'a> StructuralPartialEq for Format<'a>