Struct CheckoutCommand 

pub struct CheckoutCommand {
    pub executor: CommandExecutor,
    pub target: Option<String>,
    pub create: Option<String>,
    pub create_or_reset: Option<String>,
    pub force: bool,
    pub track: bool,
    pub no_track: bool,
    pub orphan: Option<String>,
    pub detach: bool,
    pub paths: Vec<String>,
    pub quiet: bool,
}

Builder for git checkout.

Fields

executor: CommandExecutor

Shared executor.

target: Option<String>

Target branch, commit, or tree-ish.

create: Option<String>

-b create branch.

create_or_reset: Option<String>

-B create/reset branch.

force: bool

--force / -f.

track: bool

--track.

no_track: bool

--no-track.

orphan: Option<String>

--orphan.

detach: bool

--detach.

paths: Vec<String>

Pathspecs.

quiet: bool

--quiet.

Implementations

impl CheckoutCommand

pub fn new() -> Self

New checkout command.

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

Switch to the named branch/commit.

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

Create a new branch (-b).

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

Create or reset a branch (-B).

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

--force.

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

--track.

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

--no-track.

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

Create an orphan branch.

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

Detach HEAD.

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

Restore a path from the index or tree.

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

Suppress output.

Trait Implementations

impl Clone for CheckoutCommand

fn clone(&self) -> CheckoutCommand

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CheckoutCommand

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

Formats the value using the given formatter.

impl Default for CheckoutCommand

fn default() -> CheckoutCommand

Returns the “default value” for a type.

impl GitCommand for CheckoutCommand

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.