Struct AddCommand 

pub struct AddCommand {
    pub executor: CommandExecutor,
    pub paths: Vec<String>,
    pub all: bool,
    pub update: bool,
    pub force: bool,
    pub dry_run: bool,
    pub verbose: bool,
    pub intent_to_add: bool,
    pub patch: bool,
    pub ignore_errors: bool,
}

Builder for git add.

Fields

executor: CommandExecutor

Shared executor.

paths: Vec<String>

Pathspecs to add. . or -A is common.

all: bool

--all / -A.

update: bool

--update / -u.

force: bool

--force / -f.

dry_run: bool

--dry-run / -n.

verbose: bool

--verbose / -v.

intent_to_add: bool

--intent-to-add / -N.

patch: bool

--patch / -p.

ignore_errors: bool

--ignore-errors.

Implementations

impl AddCommand

pub fn new() -> Self

New empty add command.

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

Add a pathspec.

pub fn paths<I, S>(&mut self, ps: I) -> &mut Self

where I: IntoIterator<Item = S>, S: Into<String>,

Add many pathspecs.

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

Stage every change, including deletions and new files (-A).

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

Stage only modifications and deletions (-u).

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

Override ignore rules.

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

Show what would happen without changing anything.

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

Be verbose.

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

Record only that a path will be added later.

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

Interactively stage hunks.

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

Continue past files that cannot be added.

Trait Implementations

impl Clone for AddCommand

fn clone(&self) -> AddCommand

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AddCommand

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

Formats the value using the given formatter.

impl Default for AddCommand

fn default() -> AddCommand

Returns the “default value” for a type.

impl GitCommand for AddCommand

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.