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

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

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.

impl Repository

Which Easy is for me?

For one-off commands and single-threaded applications, use EasyShared or Easy as they don’t allow mutable repository access which won’t be needed.

When multiple threads are involved, use EasyArc instead.

Finally, if there is the need for adapting to changed object packs on disk or working with namespaces, mutable Repository access is needed, as provided by EasyArcExclusive. Currently mutable shared access is only available in thread-save versions, but that shall be fixed in the future as Rust’s support for GATs becomes stable.

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

Transform this instance into an EasyShared with borrowed Repository.

Since a standard reference is used, the repository can never be mutated, which is required for the fewest operations.

pub fn into_easy(self) -> Easy

Transform this instance into an Easy, offering shared immutable access to the repository, for the current thread.

pub fn into_easy_arc(self) -> EasyArc

Transform this instance into an EasyArc, offering shared immutable access to the repository for use across threads.

pub fn into_easy_arc_exclusive(self) -> EasyArcExclusive

Transform this instance into an EasyArcExclusive, offering shared immutable access to the repository for use across threads.

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<Easy> for Repository

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<EasyArc> for Repository

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

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.