Struct BranchCommand 

pub struct BranchCommand {

    pub executor: CommandExecutor,
    pub list: bool,
    pub all: bool,
    pub remotes: bool,
    pub verbose: bool,
    pub name: Option<String>,
    pub start_point: Option<String>,
    pub delete: Option<String>,
    pub force_delete: bool,
    pub rename_from: Option<String>,
    pub rename_to: Option<String>,
    pub track: bool,
    pub no_track: bool,
    pub set_upstream_to: Option<String>,
    pub unset_upstream: bool,
    pub show_current: bool,
    pub contains: Option<String>,
    pub merged: Option<String>,
}

Builder for git branch.

Fields

executor: CommandExecutor

Shared executor.

list: bool

-l list.

all: bool

-a include remotes.

remotes: bool

-r remotes only.

verbose: bool

-v verbose.

name: Option<String>

Branch to create or operate on.

start_point: Option<String>

Start-point for creation.

delete: Option<String>

-d.

force_delete: bool

-D force delete.

rename_from: Option<String>

-m.

rename_to: Option<String>

-m target.

track: bool

--track.

no_track: bool

--no-track.

set_upstream_to: Option<String>

--set-upstream-to.

unset_upstream: bool

--unset-upstream.

show_current: bool

--show-current.

contains: Option<String>

--contains filter.

merged: Option<String>

--merged filter.

Implementations

impl BranchCommand

pub fn new() -> Self

New branch command.

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

List mode.

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

Include remote-tracking branches.

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

Remote-tracking branches only.

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

-v.

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

Create a branch with this name.

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

Start-point for create.

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

Delete a branch (-d).

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

Force delete.

pub fn rename( &mut self, from: impl Into<String>, to: impl Into<String>, ) -> &mut Self

Rename branch (-m <old> <new>).

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

Set upstream.

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

Unset upstream.

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

--track.

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

--no-track.

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

--show-current.

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

Filter branches containing commit.

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

Filter branches merged into commit.

Trait Implementations

impl Clone for BranchCommand

fn clone(&self) -> BranchCommand

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BranchCommand

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

Formats the value using the given formatter.

impl Default for BranchCommand

fn default() -> BranchCommand

Returns the “default value” for a type.

impl GitCommand for BranchCommand

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.