[−][src]Struct git2::DescribeOptions
Options which indicate how a Describe
is created.
Methods
impl DescribeOptions
[src]
impl DescribeOptions
pub fn new() -> DescribeOptions | [src] |
Creates a new blank set of formatting options for a description.
pub fn max_candidates_tags(&mut self, max: u32) -> &mut Self | [src] |
pub fn describe_tags(&mut self) -> &mut Self | [src] |
Sets the reference lookup strategy
This behaves like the --tags
option to git-describe.
pub fn describe_all(&mut self) -> &mut Self | [src] |
Sets the reference lookup strategy
This behaves like the --all
option to git-describe.
pub fn only_follow_first_parent(&mut self, follow: bool) -> &mut Self | [src] |
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 | [src] |
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 | [src] |
Trait Implementations
impl Default for DescribeOptions
[src]
impl Default for DescribeOptions
Auto Trait Implementations
impl !Send for DescribeOptions
impl !Send for DescribeOptions
impl !Sync for DescribeOptions
impl !Sync for DescribeOptions
Blanket Implementations
impl<T> From for T
[src]
impl<T> From for T
impl<T, U> Into for T where
U: From<T>,
[src]
impl<T, U> Into for T where
U: From<T>,
impl<T, U> TryFrom for T where
T: From<U>,
[src]
impl<T, U> TryFrom for T where
T: From<U>,
type Error = !
🔬 This is a nightly-only experimental API. (
try_from
)The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error> | [src] |
impl<T> Borrow for T where
T: ?Sized,
[src]
impl<T> Borrow for T where
T: ?Sized,
impl<T> BorrowMut for T where
T: ?Sized,
[src]
impl<T> BorrowMut for T where
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T | [src] |
impl<T, U> TryInto for T where
U: TryFrom<T>,
[src]
impl<T, U> TryInto for T where
U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
🔬 This is a nightly-only experimental API. (
try_from
)The type returned in the event of a conversion error.
fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error> | [src] |
impl<T> Any for T where
T: 'static + ?Sized,
[src]
impl<T> Any for T where
T: 'static + ?Sized,
fn get_type_id(&self) -> TypeId | [src] |