Struct git2::DescribeOptions
source · pub struct DescribeOptions { /* private fields */ }Expand description
Options which indicate how a Describe is created.
Implementations§
source§impl DescribeOptions
impl DescribeOptions
sourcepub fn new() -> DescribeOptions
pub fn new() -> DescribeOptions
Creates a new blank set of formatting options for a description.
Sets the reference lookup strategy
This behaves like the --tags option to git-describe.
sourcepub fn describe_all(&mut self) -> &mut Self
pub fn describe_all(&mut self) -> &mut Self
Sets the reference lookup strategy
This behaves like the --all option to git-describe.
sourcepub fn only_follow_first_parent(&mut self, follow: bool) -> &mut Self
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.
sourcepub fn show_commit_oid_as_fallback(&mut self, show: bool) -> &mut Self
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.