Struct GitRepoInfo

pub struct GitRepoInfo {
    pub url: GitUrl,
    pub head: Option<GitCommitMeta>,
    pub credentials: Option<GitCredentials>,
    pub branch: Option<String>,
    pub path: Option<PathBuf>,
}

Fields

url: GitUrl

The remote url of the repo

head: Option<GitCommitMeta>

The current commit. This can be configured prior to clone with with_commit()

credentials: Option<GitCredentials>

The ssh key or user/pass needed to clone for private repo

branch: Option<String>

The name of the remote branch. This can be configured with a local branch name prior to clone with with_branch().

path: Option<PathBuf>

The location of the repo on disk

Implementations

impl GitRepoInfo

pub fn to_repo(&self) -> GitRepo

pub fn to_clone(&self) -> GitRepoCloneRequest

pub fn get_remote_name(&self, r: &Repository) -> Result<String>

Return the remote name from the given git2::Repository For example, the typical remote name: origin

pub fn get_remote_branch_head_refs( &self, branch_filter: Option<Vec<String>>, ) -> Result<BranchHeads>

Return a HashMap<String, GitCommitMeta> for a branch containing the branch names and the latest commit of the branch. Providing a branch_filter` will only return branches based on patterns matching the start of the branch name.

pub fn is_commit_in_branch<'repo>( r: &'repo Repository, commit: &Commit<'_>, branch: &Branch<'_>, ) -> Result<bool>

Returns a bool if a commit exists in the branch using the git2 crate

pub fn get_git2_branch<'repo>( r: &'repo Repository, local_branch: &Option<String>, ) -> Result<Option<Branch<'repo>>>

Return the git2::Branch struct for a local repo (as opposed to a remote repo) If local_branch is not provided, we’ll select the current active branch, based on HEAD

pub fn remote_url_from_repository(r: &Repository) -> Result<Option<String>>

Return the remote url from the given Repository

Returns None if current branch is local only

pub fn git_remote_from_path(path: &Path) -> Result<Option<String>>

Returns the remote url after opening and validating repo from the local path

pub fn git_remote_from_repo(local_repo: &Repository) -> Result<Option<String>>

Returns the remote url from the git2::Repository struct

pub fn list_files_changed_between<S: AsRef<str>>( &self, commit1: S, commit2: S, ) -> Result<Option<Vec<PathBuf>>>

Returns a Result<Option<Vec<PathBuf>>> containing files changed between commit1 and commit2

Examples found in repository

examples/path_changed.rs (lines 30-33)

fn main() -> Result<()> {
    let current_dir = env::current_dir()?;

    let repo = GitRepo::open(current_dir, None, None)?;

    println!(
        "Files that have changes at commit: a7cf222c46ad32f2802e79e1935f753a27adc9e8\n{:?}",
        repo.to_info()
            .list_files_changed_at("a7cf222c46ad32f2802e79e1935f753a27adc9e8")
    );

    println!(
        "Files that have changed:\n{:?}",
        repo.to_info().list_files_changed_between(
            "9c6c5e65c3590e299316d34718674de333bdd9c8",
            "c097ad2a8c07bf2e3df64e6e603eee0473ad8133"
        )
    );

    println!(
        "Has Cargo.toml changed?: {:?}",
        repo.to_info().has_path_changed("Cargo.toml")
    );

    println!(
        "Has src changed?: {:?}",
        repo.to_info().has_path_changed("src")
    );

    println!(
        "Has LICENSE changed?: {:?}",
        repo.to_info().has_path_changed("LICENSE")
    );

    Ok(())
}

pub fn list_files_changed_at<S: AsRef<str>>( &self, commit: S, ) -> Result<Option<Vec<PathBuf>>>

Returns a Result<Option<Vec<PathBuf>>> containing files changed between commit and commit~1 (the previous commit)

Examples found in repository

examples/path_changed.rs (line 25)

fn main() -> Result<()> {
    let current_dir = env::current_dir()?;

    let repo = GitRepo::open(current_dir, None, None)?;

    println!(
        "Files that have changes at commit: a7cf222c46ad32f2802e79e1935f753a27adc9e8\n{:?}",
        repo.to_info()
            .list_files_changed_at("a7cf222c46ad32f2802e79e1935f753a27adc9e8")
    );

    println!(
        "Files that have changed:\n{:?}",
        repo.to_info().list_files_changed_between(
            "9c6c5e65c3590e299316d34718674de333bdd9c8",
            "c097ad2a8c07bf2e3df64e6e603eee0473ad8133"
        )
    );

    println!(
        "Has Cargo.toml changed?: {:?}",
        repo.to_info().has_path_changed("Cargo.toml")
    );

    println!(
        "Has src changed?: {:?}",
        repo.to_info().has_path_changed("src")
    );

    println!(
        "Has LICENSE changed?: {:?}",
        repo.to_info().has_path_changed("LICENSE")
    );

    Ok(())
}

pub fn expand_partial_commit_id<S: AsRef<str>>( &self, partial_commit_id: S, ) -> Result<String>

Takes in a partial commit SHA-1, and attempts to expand to the full 40-char commit id

Examples found in repository

examples/expand-partial-commit.rs (line 16)

fn main() -> Result<()> {
    let current_dir = env::current_dir()?;

    let repo = GitRepo::open(current_dir, None, None)?;

    println!("{:?}", repo.to_info().expand_partial_commit_id("c097ad2"));

    Ok(())
}

pub fn has_path_changed<P: AsRef<Path>>(&self, path: P) -> Result<bool>

Checks the list of files changed between last 2 commits (HEAD and HEAD~1). Returns bool depending on whether any changes were made in path. A path should be relative to the repo root. Can be a file or a directory.

Examples found in repository

examples/path_changed.rs (line 38)

fn main() -> Result<()> {
    let current_dir = env::current_dir()?;

    let repo = GitRepo::open(current_dir, None, None)?;

    println!(
        "Files that have changes at commit: a7cf222c46ad32f2802e79e1935f753a27adc9e8\n{:?}",
        repo.to_info()
            .list_files_changed_at("a7cf222c46ad32f2802e79e1935f753a27adc9e8")
    );

    println!(
        "Files that have changed:\n{:?}",
        repo.to_info().list_files_changed_between(
            "9c6c5e65c3590e299316d34718674de333bdd9c8",
            "c097ad2a8c07bf2e3df64e6e603eee0473ad8133"
        )
    );

    println!(
        "Has Cargo.toml changed?: {:?}",
        repo.to_info().has_path_changed("Cargo.toml")
    );

    println!(
        "Has src changed?: {:?}",
        repo.to_info().has_path_changed("src")
    );

    println!(
        "Has LICENSE changed?: {:?}",
        repo.to_info().has_path_changed("LICENSE")
    );

    Ok(())
}

pub fn has_path_changed_between<P: AsRef<Path>, S: AsRef<str>>( &self, path: P, commit1: S, commit2: S, ) -> Result<bool>

Checks the list of files changed between 2 commits (commit1 and commit2). Returns bool depending on whether any changes were made in path. A path should be relative to the repo root. Can be a file or a directory.

pub fn new_commits_exist(&self) -> Result<bool>

Check if new commits exist by performing a shallow clone and comparing branch heads

Examples found in repository

examples/new_commits.rs (line 21)

fn main() -> Result<()> {
    let tempdir = Temp::new_dir()?;

    // We're just using this for cloning
    let _clone_repo = GitRepo::new("https://github.com/tjtelan/git-meta-rs.git")?
        .to_clone()
        .git_clone(&tempdir)?;

    let repo = GitRepo::open(
        tempdir.to_path_buf(),
        Some("main".to_string()),
        Some("f6eb3d6b7998989a48ed1024313fcac401c175fb".to_string()),
    )?;

    println!(
        "Are there new commits?: {:?}",
        repo.to_info().new_commits_exist()
    );

    Ok(())
}

pub fn build_git2_remotecallback(&self) -> Result<RemoteCallbacks<'_>>

Builds a git2::RemoteCallbacks using self.credentials to be used in authenticated calls to a remote repo

Trait Implementations

impl Clone for GitRepoInfo

fn clone(&self) -> GitRepoInfo

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GitRepoInfo

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

Formats the value using the given formatter.

impl Default for GitRepoInfo

fn default() -> GitRepoInfo

Returns the “default value” for a type.

impl From<&GitRepo> for GitRepoInfo

fn from(repo: &GitRepo) -> Self

Convert from GitRepo to GitRepoCloneRequest.

impl From<&GitRepoCloneRequest> for GitRepoInfo

fn from(repo: &GitRepoCloneRequest) -> Self

Convert from &GitRepoCloneRequest to GitRepoInfo.

impl From<&GitRepoInfo> for GitRepo

fn from(repo: &GitRepoInfo) -> Self

Convert from &GitRepoInfo to GitRepo.

impl From<&GitRepoInfo> for GitRepoCloneRequest

fn from(repo: &GitRepoInfo) -> Self

Convert from &GitRepoInfo to GitRepoCloneRequest.

impl PartialEq for GitRepoInfo

fn eq(&self, other: &GitRepoInfo) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for GitRepoInfo