Struct radicle_surf::vcs::git::GitRepository

pub struct GitRepository(_);

Wrapper around the git2's git2::Repository type. This is to to limit the functionality that we can do on the underlying object.

Methods

impl<'repo> GitRepository

pub fn new(repo_uri: &str) -> Result<Self, GitError>

Open a git repository given its URI.

Examples

use radicle_surf::vcs::git::{Branch, BranchName, GitBrowser, GitRepository};

let repo = GitRepository::new("./data/git-platinum").unwrap();
let browser = GitBrowser::new(&repo).unwrap();

let mut branches = browser.list_branches(None).unwrap();
branches.sort();

assert_eq!(
    branches,
    vec![
        Branch::local(BranchName::new("master")),
        Branch::remote(BranchName::new("origin/HEAD")),
        Branch::remote(BranchName::new("origin/dev")),
        Branch::remote(BranchName::new("origin/master")),
    ]
);

Trait Implementations

impl Debug for GitRepository

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

Formats the value using the given formatter.

impl From<Repository> for GitRepository

fn from(repo: Repository) -> Self

Performs the conversion.

impl<'repo> VCS<'repo, Commit<'repo>, GitError> for GitRepository

type HistoryId = GitObject

The way to identify a History.

type ArtefactId = Oid

The way to identify an artifact.

fn get_history(
    &'repo self,
    history_id: Self::HistoryId
) -> Result<GitHistory, GitError>

Find a History in a Repo given a way to identify it

fn get_histories(&'repo self) -> Result<Vec<GitHistory>, GitError>

Find all histories in a Repo

fn get_identifier(artifact: &'repo Commit) -> Self::ArtefactId

Identify artifacts of a Repository