Struct ForEachRefCommand 

pub struct ForEachRefCommand {
    pub executor: CommandExecutor,
    pub patterns: Vec<String>,
    pub format: Option<String>,
    pub count: Option<u32>,
    pub sort: Option<String>,
    pub contains: Option<String>,
    pub merged: Option<String>,
    pub no_merged: Option<String>,
    pub points_at: Option<String>,
}

Builder for git for-each-ref.

Fields

executor: CommandExecutor

Shared executor.

patterns: Vec<String>

Patterns to match (e.g. "refs/heads/*").

format: Option<String>

--format=<fmt>.

count: Option<u32>

--count=<n>.

sort: Option<String>

--sort=<key>.

contains: Option<String>

--contains.

merged: Option<String>

--merged.

no_merged: Option<String>

--no-merged.

points_at: Option<String>

--points-at.

Implementations

impl ForEachRefCommand

pub fn new() -> Self

New command.

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

Add a pattern.

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

Custom --format.

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

--count.

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

--sort.

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

--contains.

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

--merged.

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

--no-merged.

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

--points-at.

Trait Implementations

impl Clone for ForEachRefCommand

fn clone(&self) -> ForEachRefCommand

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ForEachRefCommand

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

Formats the value using the given formatter.

impl Default for ForEachRefCommand

fn default() -> ForEachRefCommand

Returns the “default value” for a type.

impl GitCommand for ForEachRefCommand

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.