Struct DescribeCommand 

pub struct DescribeCommand {
    pub executor: CommandExecutor,
    pub commits: Vec<String>,
    pub tags: bool,
    pub all: bool,
    pub always: bool,
    pub long: bool,
    pub dirty: Option<Option<String>>,
    pub abbrev: Option<u32>,
    pub match_pattern: Option<String>,
    pub exclude: Option<String>,
    pub first_parent: bool,
}

Builder for git describe.

Fields

executor: CommandExecutor

Shared executor.

commits: Vec<String>

Commit-ish(es) to describe.

tags: bool

--tags include lightweight tags.

all: bool

--all include all refs, not just tags.

always: bool

--always fall back to abbreviated SHA when nothing matches.

long: bool

--long always show the long form (tag-count-gSHA).

dirty: Option<Option<String>>

--dirty[=<mark>].

abbrev: Option<u32>

--abbrev=N.

match_pattern: Option<String>

--match=<pattern>.

exclude: Option<String>

--exclude=<pattern>.

first_parent: bool

--first-parent.

Implementations

impl DescribeCommand

pub fn new() -> Self

New describe command.

pub fn commit(&mut self, c: impl Into<String>) -> &mut Self

Add a commit-ish to describe.

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

--tags.

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

--all.

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

--always.

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

--long.

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

--dirty with default mark (-dirty).

pub fn dirty_mark(&mut self, mark: impl Into<String>) -> &mut Self

--dirty=<mark>.

pub fn abbrev(&mut self, n: u32) -> &mut Self

--abbrev=N.

pub fn match_pattern(&mut self, p: impl Into<String>) -> &mut Self

--match=<pattern>.

pub fn exclude(&mut self, p: impl Into<String>) -> &mut Self

--exclude=<pattern>.

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

--first-parent.

Trait Implementations

impl Clone for DescribeCommand

fn clone(&self) -> DescribeCommand

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for DescribeCommand

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for DescribeCommand

fn default() -> DescribeCommand

Returns the “default value” for a type.

impl GitCommand for DescribeCommand

type Output = String

Trimmed description string, e.g. v1.2.3-5-gabc1234.

fn get_executor(&self) -> &CommandExecutor

Borrow the shared executor.

fn get_executor_mut(&mut self) -> &mut CommandExecutor

Mutably borrow the shared executor.

fn build_command_args(&self) -> Vec<String>

Build the full argument vector (subcommand + flags + positionals) excluding the leading git program.

fn execute<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<String>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Run the command and decode its output into Self::Output.

fn execute_raw<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<CommandOutput>> + Send + 'async_trait>>

where Self: Sync + 'async_trait, 'life0: 'async_trait,

Spawn git with the given arguments and return the raw output.

fn arg<S: AsRef<OsStr>>(&mut self, arg: S) -> &mut Self

Append a single raw argument.

fn args<I, S>(&mut self, args: I) -> &mut Self

where I: IntoIterator<Item = S>, S: AsRef<OsStr>,

Append several raw arguments.

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

Append a --flag (or -f if a single character).

fn option(&mut self, key: &str, value: &str) -> &mut Self

Append a --key value pair.

fn current_dir<P: Into<PathBuf>>(&mut self, dir: P) -> &mut Self

Run git in the given working directory.

fn env<K: Into<OsString>, V: Into<OsString>>( &mut self, key: K, value: V, ) -> &mut Self

Set an environment variable for this invocation.

fn with_timeout(&mut self, timeout: Duration) -> &mut Self

Cap execution time. On expiry the process is killed and Error::Timeout is returned.

fn with_timeout_secs(&mut self, seconds: u64) -> &mut Self

Convenience: set timeout in whole seconds.