Struct git::Repository

pub struct Repository { /* private fields */ }

A light cloneable, simple wrapper around the git2::Repository struct

Implementations

impl Repository

pub fn open_from_env() -> Result<Self>

Find and open an existing repository, respecting git environment variables. This will check for and use $GIT_DIR, and if unset will search for a repository starting in the current directory, walking to the root.

Errors

Will result in an error if the repository cannot be opened.

pub fn open_from_path(path: &Path) -> Result<Self>

Attempt to open an already-existing repository at path.

Errors

Will result in an error if the repository cannot be opened.

pub fn load_config(&self) -> Result<Config>

Load the git configuration for the repository.

Errors

Will result in an error if the configuration is invalid.

pub fn load_commit_diff(
    &self,
    hash: &str,
    config: &CommitDiffLoaderOptions
) -> Result<CommitDiff>

Load a diff for a commit hash

Errors

Will result in an error if the commit cannot be loaded.

pub fn find_reference(&self, reference: &str) -> Result<Reference>

Find a reference by the reference name.

Errors

Will result in an error if the reference cannot be found.

pub fn find_commit(&self, reference: &str) -> Result<Commit>

Find a commit by a reference name.

Errors

Will result in an error if the reference cannot be found or is not a commit.

Trait Implementations

impl Clone for Repository

fn clone(&self) -> Repository

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Repository

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

Formats the value using the given formatter.

impl From<Repository> for Repository

fn from(repository: Repository) -> Self

Converts to this type from the input type.