Struct branchless::git::GitRunInfo

pub struct GitRunInfo {
    pub path_to_git: PathBuf,
    pub working_directory: PathBuf,
    pub env: HashMap<OsString, OsString>,
}

Path to the git executable on disk to be executed.

Fields

path_to_git: PathBuf

The path to the Git executable on disk.

working_directory: PathBuf

The working directory that the Git executable should be run in.

env: HashMap<OsString, OsString>

The environment variables that should be passed to the Git process.

Implementations

impl GitRunInfo

pub fn run<S: AsRef<OsStr> + Debug>( &self, effects: &Effects, event_tx_id: Option<EventTransactionId>, args: &[S] ) -> Result<ExitCode>

Run Git in a subprocess, and inform the user.

This is suitable for commands which affect the working copy or should run hooks. We don’t want our process to be responsible for that.

args contains the list of arguments to pass to Git, not including the Git executable itself.

Returns the exit code of Git (non-zero signifies error).

pub fn run_direct_no_wrapping( &self, event_tx_id: Option<EventTransactionId>, args: &[impl AsRef<OsStr> + Debug] ) -> Result<ExitCode>

Run the provided command without wrapping it in an Effects operation. This may clobber progress reporting, and is usually not what you want; see GitRunInfo::run instead.

pub fn run_silent<S: AsRef<str> + Debug>( &self, repo: &Repo, event_tx_id: Option<EventTransactionId>, args: &[S], opts: GitRunOpts ) -> Result<GitRunResult>

Run Git silently (don’t display output to the user).

Whenever possible, use git2’s bindings to Git instead, as they’re considerably more lightweight and reliable.

Returns the stdout of the Git invocation.

pub fn run_hook<S: AsRef<str> + Debug>( &self, effects: &Effects, repo: &Repo, hook_name: &str, event_tx_id: EventTransactionId, args: &[S], stdin: Option<BString> ) -> Result<()>

Run a provided Git hook if it exists for the repository.

See the man page for githooks(5) for more detail on Git hooks.

Trait Implementations

impl Clone for GitRunInfo

fn clone(&self) -> GitRunInfo

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GitRunInfo

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

Formats the value using the given formatter.