Struct GitRepoCloneRequest

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

Represents request to clone repo to disk

After cloning, returns a GitRepo

Clone a repo with .git_clone() or git_clone_shallow()

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 GitRepoCloneRequest

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

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_credentials(self, creds: Option<GitCredentials>) -> Self

Set GitCredentials for private repos. None indicates public repo

pub fn to_repo(&self) -> GitRepo

pub fn to_info(&self) -> GitRepoInfo

pub fn git_clone<P: AsRef<Path>>(&self, target: P) -> Result<GitRepo>

Examples found in repository

examples/new_commits.rs (line 11)

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 git_clone_shallow<P: AsRef<Path>>(&self, target: P) -> Result<GitRepo>

Trait Implementations

impl Clone for GitRepoCloneRequest

fn clone(&self) -> GitRepoCloneRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GitRepoCloneRequest

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

Formats the value using the given formatter.

impl Default for GitRepoCloneRequest

fn default() -> GitRepoCloneRequest

Returns the “default value” for a type.

impl From<&GitRepo> for GitRepoCloneRequest

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<&GitRepoCloneRequest> for GitRepoInfo

fn from(repo: &GitRepoCloneRequest) -> Self

Convert from &GitRepoCloneRequest to GitRepoInfo.

impl From<&GitRepoInfo> for GitRepoCloneRequest

fn from(repo: &GitRepoInfo) -> Self

Convert from &GitRepoInfo to GitRepoCloneRequest.

impl From<GitRepo> for GitRepoCloneRequest

fn from(repo: GitRepo) -> Self

Convert from GitRepo to GitRepoCloneRequest.

impl PartialEq for GitRepoCloneRequest

fn eq(&self, other: &GitRepoCloneRequest) -> 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 GitRepoCloneRequest