Struct gix_revision::describe::Options

pub struct Options<'name> {
    pub name_by_oid: HashMap<ObjectId, Cow<'name, BStr>>,
    pub max_candidates: usize,
    pub fallback_to_oid: bool,
    pub first_parent: bool,
}

Available on crate feature describe only.

The options required to call describe().

Fields

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

The candidate names from which to determine the name to use for the describe string, as a mapping from a commit id and the name associated with it.

max_candidates: usize

The amount of names we will keep track of. Defaults to the maximum of 32.

If the number is exceeded, it will be capped at 32 and defaults to 10.

fallback_to_oid: bool

If no candidate for naming, always show the abbreviated hash. Default: false.

first_parent: bool

Only follow the first parent during graph traversal. Default: false.

This may speed up the traversal at the cost of accuracy.

Trait Implementations

impl<'name> Clone for Options<'name>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'name> Debug for Options<'name>

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

Formats the value using the given formatter.

impl<'name> Default for Options<'name>

fn default() -> Self

Returns the “default value” for a type.