Struct Repository

Source

pub struct Repository { /* private fields */ }

Expand description

Wraps a [gix::Repository], representing an open git repository.

Created via Repository::discover, which walks up from path until it finds a .git directory (matching git’s behaviour).

Implementations§

Source §

impl Repository

Source

pub fn discover(path: impl AsRef<Path>) -> Result<Self>

Walk up from path to find the nearest git repository.

Returns an error if no .git directory is found in any ancestor directory.

Source

pub fn workdir(&self) -> Option<&Path>

The absolute path of the repository’s working tree root.

Returns None for bare repositories.

Source

pub fn gitdir(&self) -> &Path

The absolute path of the repository’s .git directory.

Source

pub fn inner(&self) -> &Repository

Access the inner [gix::Repository] for operations that need direct access to the gix API.

Source

pub fn is_bare(&self) -> bool

Check whether this is a bare repository (has no working tree).

Source

pub fn run_git<I, S>(&self, args: I) -> Result<Vec<u8>>
where I: IntoIterator<Item = S>, S: AsRef<OsStr>,

Run a git command in the working directory and return its stdout as bytes. Runs on the calling thread.

Source

pub fn run_git_stdin<I, S>(&self, args: I, input: &[u8]) -> Result<Vec<u8>>
where I: IntoIterator<Item = S>, S: AsRef<OsStr>,

MG.18a: run a git command with input piped to its stdin, returning stdout as bytes. Runs on the calling thread.

Needed by crate::Index::apply_patch: git apply - reads the patch from stdin, and Self::run_git’s .output() gives the child a null stdin. Writing the patch to a temp file instead would leak it on a crash and race a concurrent magit in the same repository.

The write is completed and stdin dropped before waiting, so a child that consumes its whole input can exit; holding the pipe open past the write deadlocks against a child waiting on EOF.

Source