Struct git2::DescribeOptions

pub struct DescribeOptions { /* fields omitted */ }

Options which indicate how a Describe is created.

Methods

impl DescribeOptions

pub fn new() -> DescribeOptions

Creates a new blank set of formatting options for a description.

pub fn max_candidates_tags(&mut self, max: u32) -> &mut Self

pub fn describe_tags(&mut self) -> &mut Self

Sets the reference lookup strategy

This behaves like the --tags option to git-decribe.

pub fn describe_all(&mut self) -> &mut Self

Sets the reference lookup strategy

This behaves like the --all option to git-decribe.

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

Indicates when calculating the distance from the matching tag or reference whether to only walk down the first-parent ancestry.

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

If no matching tag or reference is found whether a describe option would normally fail. This option indicates, however, that it will instead fall back to showing the full id of the commit.

pub fn pattern(&mut self, pattern: &str) -> &mut Self

Trait Implementations

impl Default for DescribeOptions

fn default() -> Self

Returns the "default value" for a type.