Struct TagCommand 

pub struct TagCommand {
    pub executor: CommandExecutor,
    pub name: Option<String>,
    pub commit: Option<String>,
    pub annotated: bool,
    pub message: Option<String>,
    pub signed: bool,
    pub force: bool,
    pub delete: bool,
    pub list: bool,
    pub pattern: Option<String>,
}

Builder for git tag.

Fields

executor: CommandExecutor

Shared executor.

name: Option<String>

Tag name.

commit: Option<String>

Commit-ish to tag.

annotated: bool

-a annotated.

message: Option<String>

-m message.

signed: bool

-s signed.

force: bool

-f force.

delete: bool

-d delete.

list: bool

-l list mode.

pattern: Option<String>

Pattern filter (for list).

Implementations

impl TagCommand

pub fn new() -> Self

New tag command.

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

Name.

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

Commit to tag.

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

Annotated.

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

Tag message.

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

GPG-sign.

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

Force.

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

Delete.

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

List mode.

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

List pattern.

Trait Implementations

impl Clone for TagCommand

fn clone(&self) -> TagCommand

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TagCommand

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

Formats the value using the given formatter.

impl Default for TagCommand

fn default() -> TagCommand

Returns the “default value” for a type.

impl GitCommand for TagCommand

type Output = CommandOutput

The typed output produced by this command.

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<CommandOutput>> + 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.