Struct git2::DescribeFormatOptions
source · [−]pub struct DescribeFormatOptions { /* private fields */ }
Expand description
Options which can be used to customize how a description is formatted.
Implementations
sourceimpl DescribeFormatOptions
impl DescribeFormatOptions
sourcepub fn new() -> DescribeFormatOptions
pub fn new() -> DescribeFormatOptions
Creates a new blank set of formatting options for a description.
sourcepub fn abbreviated_size(&mut self, size: u32) -> &mut Self
pub fn abbreviated_size(&mut self, size: u32) -> &mut Self
Sets the size of the abbreviated commit id to use.
The value is the lower bound for the length of the abbreviated string, and the default is 7.
sourcepub fn always_use_long_format(&mut self, long: bool) -> &mut Self
pub fn always_use_long_format(&mut self, long: bool) -> &mut Self
Sets whether or not the long format is used even when a shorter name could be used.
sourcepub fn dirty_suffix(&mut self, suffix: &str) -> &mut Self
pub fn dirty_suffix(&mut self, suffix: &str) -> &mut Self
If the workdir is dirty and this is set, this string will be appended to the description string.
Trait Implementations
Auto Trait Implementations
impl RefUnwindSafe for DescribeFormatOptions
impl !Send for DescribeFormatOptions
impl !Sync for DescribeFormatOptions
impl Unpin for DescribeFormatOptions
impl UnwindSafe for DescribeFormatOptions
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcepub fn borrow_mut(&mut self) -> &mut T
pub fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more