Struct GitCommand 

pub struct GitCommand { /* private fields */ }

A git invocation with Mermaid’s hardening already applied.

Implementations

impl GitCommand

pub fn new() -> Self

Start a hardened git invocation. Add a working directory with Self::cwd; without one the command inherits the process’s.

pub fn cwd(self, dir: &Path) -> Self

Run in dir.

pub fn arg<S: AsRef<OsStr>>(self, arg: S) -> Self

Append one argument.

pub fn args<I, S>(self, args: I) -> Self

where I: IntoIterator<Item = S>, S: AsRef<OsStr>,

Append several arguments.

pub fn stdin_bytes(self, data: Vec<u8>) -> Self

Feed data to the command’s stdin. Lets git apply take a patch without staging it through a temp file whose lifetime we’d have to manage (and whose contents would briefly sit on disk unredacted).

pub fn run(self) -> Result<()>

Run and require success, discarding output.

Errors

git not being spawnable (not installed, not on PATH), a failure while feeding stdin or collecting output, and a nonzero exit — the message carries the command line and git’s trimmed stderr. Use Self::success where a nonzero exit is an answer rather than a failure.

pub fn success(self) -> Result<bool>

Run and report whether it exited zero, discarding output. For the predicate forms (diff --quiet, rev-parse) where a nonzero exit is an answer rather than a failure.

Errors

Only failures to run git: not spawnable, or stdin/output handling failed. The exit status never produces an Err here — that is the bool.

pub fn output(self) -> Result<String>

Run and return trimmed stdout, requiring success.

Errors

Exactly Self::output_bytes’s. Invalid UTF-8 is not among them: it is replaced lossily, so use output_bytes when the exact bytes matter.

pub fn output_bytes(self) -> Result<Vec<u8>>

Run and return raw stdout, requiring success. Use for diff --binary and anything else that need not be valid UTF-8.

Errors

git not being spawnable, a failure while feeding stdin or collecting output, and a nonzero exit — the message carries the command line and git’s trimmed stderr. Stdout written before a nonzero exit is discarded.

Trait Implementations

impl Default for GitCommand

fn default() -> Self

Returns the “default value” for a type.