Struct CherryPickCommand 

pub struct CherryPickCommand {

    pub executor: CommandExecutor,
    pub commits: Vec<String>,
    pub no_commit: bool,
    pub edit: bool,
    pub signoff: bool,
    pub reference: bool,
    pub mainline: Option<u32>,
    pub strategy: Option<String>,
    pub abort: bool,
    pub cont: bool,
    pub skip: bool,
    pub quit: bool,
    pub allow_empty: bool,
    pub keep_redundant: bool,
}

Builder for git cherry-pick.

Fields

executor: CommandExecutor

Shared executor.

commits: Vec<String>

Commits (or ranges) to pick.

no_commit: bool

--no-commit / -n.

edit: bool

--edit.

signoff: bool

--signoff / -s.

reference: bool

-x append “cherry picked from commit …”.

mainline: Option<u32>

--mainline N (for merges).

strategy: Option<String>

--strategy.

abort: bool

--abort.

cont: bool

--continue.

skip: bool

--skip.

quit: bool

--quit.

allow_empty: bool

--allow-empty.

keep_redundant: bool

--keep-redundant-commits.

Implementations

impl CherryPickCommand

pub fn new() -> Self

New command.

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

Add a commit / range.

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

Do not commit automatically.

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

Open the editor for the commit message.

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

Add Signed-off-by.

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

Append (cherry picked from commit …) to the message.

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

For merge commits, specify the mainline parent.

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

Merge strategy.

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

Abort an in-progress cherry-pick.

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

Continue after resolving conflicts.

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

Skip the current commit.

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

Forget the in-progress cherry-pick state.

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

Allow empty commits.

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

Keep commits that become empty due to the pick.

Trait Implementations

impl Clone for CherryPickCommand

fn clone(&self) -> CherryPickCommand

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CherryPickCommand

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

Formats the value using the given formatter.

impl Default for CherryPickCommand

fn default() -> CherryPickCommand

Returns the “default value” for a type.

impl GitCommand for CherryPickCommand

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.