Struct StatusCommand 

pub struct StatusCommand {
    pub executor: CommandExecutor,
    pub format: Option<StatusFormat>,
    pub branch: bool,
    pub show_stash: bool,
    pub null_terminate: bool,
    pub untracked_files: Option<String>,
    pub ignored: bool,
    pub paths: Vec<String>,
}

Builder for git status.

Fields

executor: CommandExecutor

Shared executor.

format: Option<StatusFormat>

Output format override.

branch: bool

--branch / -b.

show_stash: bool

--show-stash.

null_terminate: bool

NUL-terminate entries (-z).

untracked_files: Option<String>

--untracked-files=<mode>.

ignored: bool

--ignored.

paths: Vec<String>

Pathspec filters.

Implementations

impl StatusCommand

pub fn new() -> Self

New status command.

pub fn format(&mut self, f: StatusFormat) -> &mut Self

Set output format.

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

Include branch info.

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

Show stash count.

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

NUL-separate entries.

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

Set untracked-file mode (no, normal, all).

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

Also show ignored files.

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

Filter by path.

Trait Implementations

impl Clone for StatusCommand

fn clone(&self) -> StatusCommand

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StatusCommand

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

Formats the value using the given formatter.

impl Default for StatusCommand

fn default() -> StatusCommand

Returns the “default value” for a type.

impl GitCommand for StatusCommand

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.