Struct SubmoduleCommand 

pub struct SubmoduleCommand {
    pub executor: CommandExecutor,
    pub action: SubmoduleAction,
}

Builder for git submodule.

Fields

executor: CommandExecutor

Shared executor.

action: SubmoduleAction

Action.

Implementations

impl SubmoduleCommand

pub fn add(url: impl Into<String>) -> Self

submodule add.

pub fn path(self, p: impl Into<PathBuf>) -> Self

Set the submodule path (for add).

pub fn branch(self, b: impl Into<String>) -> Self

Set -b branch (for add).

pub fn force(self) -> Self

Set --force (for add / update / deinit).

pub fn init() -> Self

submodule init.

pub fn update() -> Self

submodule update.

pub fn with_init(self) -> Self

--init (for update).

pub fn recursive(self) -> Self

--recursive (for update / status / foreach / sync).

pub fn remote(self) -> Self

--remote (for update).

pub fn restrict_path(self, p: impl Into<PathBuf>) -> Self

Restrict to a given path.

pub fn status() -> Self

submodule status.

pub fn cached(self) -> Self

--cached (for status).

pub fn foreach(command: impl Into<String>) -> Self

submodule foreach.

pub fn deinit() -> Self

submodule deinit.

pub fn all(self) -> Self

--all (for deinit).

pub fn sync() -> Self

submodule sync.

Trait Implementations

impl Clone for SubmoduleCommand

fn clone(&self) -> SubmoduleCommand

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SubmoduleCommand

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

Formats the value using the given formatter.

impl GitCommand for SubmoduleCommand

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.