Struct Repo 

pub struct Repo { /* private fields */ }

A discovered git repository.

Implementations

impl Repo

pub fn discover(path: &Path) -> Result<Self, GitError>

Discover the repository containing path (walking upwards to the .git).

Errors

Returns GitError::Git if no repository is found or it cannot be opened.

pub fn common_dir(&self) -> &Path

The repository’s common git directory. The cache lives under here so it is shared across linked worktrees (which each have their own git dir).

pub fn git_dir(&self) -> &Path

This worktree’s git directory (per-worktree; the graph DB lives here).

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

The working directory, if this is not a bare repository. The dirty overlay reads uncommitted file contents from here.

pub fn blob_oid(&self, bytes: &[u8]) -> Result<String, GitError>

The hex git blob object id that bytes would have, without writing anything. Used to detect whether a working-copy file differs from the committed blob (same content ⇒ same id).

Errors

Returns GitError::Git if hashing fails.

pub fn head_tree_id(&self) -> Result<String, GitError>

Hex object id of the tree at HEAD.

Errors

Returns GitError::Git if HEAD cannot be resolved to a tree.

pub fn walk_blobs(&self) -> Result<Vec<BlobRef>, GitError>

Every blob reachable from the HEAD tree, with full paths.

Errors

Returns GitError if the tree cannot be traversed or a path is not valid UTF-8.

pub fn read_blob(&self, oid: &str) -> Result<Vec<u8>, GitError>

Read the bytes of the blob with hex object id oid.

Errors

Returns GitError::Git if the id is malformed or the object is absent.