Struct Repository

pub struct Repository { /* private fields */ }

A git repository (a reference to a local path containing a .git directory, or a bare some_repository.git directory)

Implementations

impl Repository

pub fn from_bare_repository(dir: impl Into<PathBuf>) -> Result<Self>

Examples

let repository = clgit::Repository::from_bare_repository(".git").unwrap();

pub fn from_regular_repository(dir: impl AsRef<Path>) -> Result<Self>

Examples

let repository = clgit::Repository::from_regular_repository(".").unwrap();

pub fn from_path(dir: impl AsRef<Path>) -> Result<Self>

Examples

let repository = clgit::Repository::from_path(".").unwrap();
let repository = clgit::Repository::from_path(".git").unwrap();

pub fn local_branches(&self) -> Result<impl Iterator<Item = Result<Branch>>>

Examples

for branch in repository.local_branches()? {
    let branch : clgit::Branch = branch?;
    println!("{}", branch.name().to_string_lossy());
    let _ = branch.commit();
}

pub fn remote_branches(&self) -> Result<impl Iterator<Item = Result<Branch>>>

Examples

for branch in repository.remote_branches()? {
    let branch : clgit::Branch = branch?;
    println!("{}", branch.name().to_string_lossy());
    let _ = branch.commit();
}

pub fn cat_file_size(&self, hash: &Hash) -> Result<u64>

Run/parse git cat-file -s [hash]

pub fn cat_file_type(&self, hash: &Hash) -> Result<FileType>

Run/parse git cat-file -t [hash]

pub fn cat_file_commit(&self, hash: &Hash) -> Result<impl Read>

Run/parse git cat-file commit [hash]

pub fn cat_file_tree(&self, hash: &Hash) -> Result<impl Read>

Run/parse git cat-file tree [hash]

pub fn cat_file_blob(&self, hash: &Hash) -> Result<impl Read>

Run/parse git cat-file blob [hash]

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, fmt: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl From<Repository> for RepositoryCache

fn from(repository: Repository) -> Self

Converts to this type from the input type.

impl TryIntoSharedRepositoryCache for Repository

fn try_into_src(self) -> Result<Arc<RepositoryCache>>

Try to convert into an Arc<RepositoryCache> on pain of std::io::Error.