Struct git_repository::Repository

pub struct Repository {
    pub refs: Store,
    pub work_tree: Option<PathBuf>,
    // some fields omitted
}

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.

These resources are meant to be shareable across threads and used by most using an Easy* type has a handle carrying additional in-memory data to accelerate data access or hold volatile data. Depending on context, EasyShared gets the fastest read-only access to the repository, whereas Easy has to go through an Rc and EasyArcExclusive through an Arc<RwLock>.

Namely, this is an object database, a reference database to point to objects.

Fields

refs: Store

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

pub fn git_dir(&self) -> &Path

pub fn objects_dir(&self) -> &Path

impl Repository

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

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 workdir(&self) -> Option<&Path>

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

impl Repository

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

impl Repository

pub fn to_easy(&self) -> EasyShared<'_>

pub fn into_easy(self) -> Easy

pub fn into_easy_arc(self) -> EasyArc

pub fn into_easy_arc_exclusive(self) -> EasyArcExclusive

Trait Implementations

impl Debug for Repository

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

Formats the value using the given formatter.

impl From<Repository> for Easy

fn from(repo: Repository) -> Self

Performs the conversion.

impl From<Repository> for EasyArc

fn from(repo: Repository) -> Self

Performs the conversion.

impl From<Repository> for EasyArcExclusive

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.