Struct git2::DescribeFormatOptions

pub struct DescribeFormatOptions {
    // some fields omitted
}

Options which can be used to customize how a description is formatted.

Methods

impl DescribeFormatOptions

fn new() -> DescribeFormatOptions

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

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.

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.

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.