Struct ShowRefCommand 

pub struct ShowRefCommand {
    pub executor: CommandExecutor,
    pub patterns: Vec<String>,
    pub heads: bool,
    pub tags: bool,
    pub verify: bool,
    pub hash: Option<Option<u32>>,
    pub dereference: bool,
    pub head: bool,
    pub exists: bool,
    pub quiet: bool,
}

Builder for git show-ref.

Fields

executor: CommandExecutor

Shared executor.

patterns: Vec<String>

Patterns to match.

heads: bool

--heads.

tags: bool

--tags.

verify: bool

--verify: error if a pattern doesn’t match.

hash: Option<Option<u32>>

--hash[=N].

dereference: bool

--dereference.

head: bool

--head.

exists: bool

--exists: test existence of a specific ref.

quiet: bool

-q quiet.

Implementations

impl ShowRefCommand

pub fn new() -> Self

New command.

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

Add a ref pattern.

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

Limit to branch refs.

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

Limit to tag refs.

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

--verify.

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

--hash.

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

--hash=N.

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

--dereference.

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

Include HEAD in output (--head).

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

--exists.

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

-q.

Trait Implementations

impl Clone for ShowRefCommand

fn clone(&self) -> ShowRefCommand

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ShowRefCommand

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

Formats the value using the given formatter.

impl Default for ShowRefCommand

fn default() -> ShowRefCommand

Returns the “default value” for a type.

impl GitCommand for ShowRefCommand

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.