Struct GitRepo

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

Use GitRepo::open() to read a repo on disk. GitRepo::new() if you need to clone the repo.

Use GitRepoCloneRequest to clone repo to disk

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 GitRepo

pub fn open( path: PathBuf, branch: Option<String>, commit_id: Option<String>, ) -> Result<Self>

Returns a GitRepo after parsing metadata from a repo

• If a local branch is not provided, current checked out branch will be used. The provided branch will be resolved to its remote branch name
• If commit_id is not provided, the current commit (the HEAD of branch) will be used

Examples found in repository

examples/open.rs (line 9)

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

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

    println!("{:?}", repo);

    Ok(())
}

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

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(())
}

examples/new_commits.rs (lines 13-17)

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(())
}

examples/path_changed.rs (line 20)

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 with_path(self, path: PathBuf) -> Result<Self>

Set the location of GitRepo on the filesystem

pub fn with_branch(self, branch: Option<String>) -> Self

Intended to be set with the remote name branch of GitRepo

pub fn with_commit(self, commit_id: Option<String>) -> Result<Self>

Reinit GitRepo with commit id

pub fn with_git2_commit(self, commit: Option<Commit<'_>>) -> Self

Set the GitCommitMeta from git2::Commit

pub fn with_credentials(self, creds: Option<GitCredentials>) -> Self

Set GitCredentials for private repos. None indicates public repo

pub fn new<S: AsRef<str>>(url: S) -> Result<Self>

Create a new GitRepo with url. Use along with with_* methods to set other fields of GitRepo. Use GitRepoCloner if you need to clone the repo, and convert back with GitRepo.into()

Examples found in repository

examples/new_commits.rs (line 9)

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 to_clone(&self) -> GitRepoCloneRequest

Examples found in repository

examples/new_commits.rs (line 10)

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 to_info(&self) -> GitRepoInfo

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(())
}

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(())
}

examples/path_changed.rs (line 24)

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 to_repository(&self) -> Result<Repository>

Returns a git2::Repository from self.path

pub fn to_repository_from_path<P: AsRef<Path> + Debug>( path: P, ) -> Result<Repository>

Returns a git2::Repository from a given repo directory path

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

Test whether GitRepo is a shallow clone

Trait Implementations

impl Clone for GitRepo

fn clone(&self) -> GitRepo

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GitRepo

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

Formats the value using the given formatter.

impl Default for GitRepo

fn default() -> GitRepo

Returns the “default value” for a type.

impl From<&GitRepo> for GitRepoCloneRequest

fn from(repo: &GitRepo) -> Self

Convert from GitRepo to GitRepoCloneRequest.

impl From<&GitRepo> for GitRepoInfo

fn from(repo: &GitRepo) -> Self

Convert from GitRepo to GitRepoCloneRequest.

impl From<&GitRepoCloneRequest> for GitRepo

fn from(repo: &GitRepoCloneRequest) -> Self

Convert from &GitRepoCloneRequest to GitRepo.

impl From<&GitRepoInfo> for GitRepo

fn from(repo: &GitRepoInfo) -> Self

Convert from &GitRepoInfo to GitRepo.

impl From<GitRepo> for GitRepoCloneRequest

fn from(repo: GitRepo) -> Self

Convert from GitRepo to GitRepoCloneRequest.

impl PartialEq for GitRepo

fn eq(&self, other: &GitRepo) -> 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 TryFrom<Repository> for GitRepo

type Error = Report

The type returned in the event of a conversion error.

fn try_from(repo: Repository) -> Result<Self, Self::Error>

Performs the conversion.

impl StructuralPartialEq for GitRepo