Struct git2::DescribeOptions

source ·
pub struct DescribeOptions { /* private fields */ }
Expand description

Options which indicate how a Describe is created.

Implementations§

source§

impl DescribeOptions

source

pub fn new() -> DescribeOptions

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

source

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

source

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

Sets the reference lookup strategy

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

source

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

Sets the reference lookup strategy

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

source

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.

source

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.

source

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

Trait Implementations§

source§

impl Default for DescribeOptions

source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

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> 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, U> TryFrom<U> for T
where U: Into<T>,

§

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>,

§

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.