Struct git_repository::Repository

pub struct Repository {
    pub refs: RefStore,
    pub work_tree: Option<PathBuf>,
    /* private fields */
}

A instance with access to everything a git repository entails, best imagined as container for most for system resources required to interact with a git repository which are loaded in once the instance is created.

The main difference to the easy::Handle is that this type is Sync, and thus can be referenced into a threaded context for creation of thread-local handles.

Fields

refs: RefStore

A store for references to point at objects

work_tree: Option<PathBuf>

The path to the worktree at which to find checked out files

Implementations

impl Repository

pub fn kind(&self) -> Kind

Return the kind of repository, either bare or one with a work tree.

pub fn to_easy(&self) -> Handle

Add thread-local state to an easy-to-use handle for the most convenient API.

impl Repository

pub fn open(path: impl Into<PathBuf>) -> Result<Self, Error>

Open a git repository at the given path, possibly expanding it to path/.git if path is a work tree dir.

impl Repository

pub fn init(directory: impl AsRef<Path>, kind: Kind) -> Result<Self, Error>

Create a repository with work-tree within directory, creating intermediate directories as needed.

Fails without action if there is already a .git repository inside of directory, but won’t mind if the directory otherwise is non-empty.

impl Repository

pub fn path(&self) -> &Path

The path to the .git directory itself, or equivalent if this is a bare repository.

pub fn git_dir(&self) -> &Path

Return the path to the repository itself, containing objects, references, configuration, and more.

Synonymous to path().

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

Return the path to the working directory if this is not a bare repository.

pub fn objects_dir(&self) -> &Path

Return the path to the directory containing all objects.

impl Repository

pub fn discover(directory: impl AsRef<Path>) -> Result<Self, Error>

Try to open a git repository in directory and search upwards through its parents until one is found.

Trait Implementations

impl Debug for Repository

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

Formats the value using the given formatter.

impl From<&'_ Repository> for Handle

fn from(repo: &Repository) -> Self

Performs the conversion.

impl From<Repository> for Handle

fn from(repo: Repository) -> Self

Performs the conversion.

impl PartialEq<Repository> for Repository

fn eq(&self, other: &Repository) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl TryFrom<Path> for Repository

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Path) -> Result<Self, Self::Error>

Performs the conversion.