Struct CloneSpec 

#[non_exhaustive]
pub struct CloneSpec {
    pub branch: Option<String>,
    pub depth: Option<u32>,
    pub filter: Option<CloneFilter>,
    pub single_branch: bool,
    pub origin: Option<String>,
    pub bare: bool,
}

Options for GitApi::clone_repo (git clone).

#[non_exhaustive], so build it through CloneSpec::new and the chained setters rather than a struct literal.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

branch: Option<String>

Check out this branch instead of the remote’s default (--branch).

depth: Option<u32>

Shallow-clone to this many commits (--depth). git silently ignores the flag for a plain local-path source (warns, still clones fully); use a file:// URL to shallow-clone locally.

filter: Option<CloneFilter>

Use a partial-clone object filter (--filter=blob:none or --filter=tree:0).

single_branch: bool

Limit the clone to the selected branch (--single-branch).

origin: Option<String>

Name the remote created by the clone instead of origin (--origin). The value is checked before spawning git.

bare: bool

Create a bare repository (--bare).

Implementations

impl CloneSpec

pub fn new() -> Self

A plain full clone of the remote’s default branch.

pub fn branch(self, branch: impl Into<String>) -> Self

Check out branch instead of the remote’s default (--branch).

pub fn depth(self, depth: u32) -> Self

Shallow-clone to depth commits (--depth); see the field doc for the local-path caveat.

pub fn filter(self, filter: CloneFilter) -> Self

Use a partial clone filter (--filter=<value>).

pub fn single_branch(self) -> Self

Restrict the clone to the selected branch (--single-branch).

pub fn origin(self, name: impl Into<String>) -> Self

Name the clone’s remote name instead of origin (--origin <name>). The value is rejected before spawning if it is empty, flag-like, or contains an embedded NUL.

pub fn bare(self) -> Self

Clone as a bare repository (--bare).

Trait Implementations

impl Clone for CloneSpec

fn clone(&self) -> CloneSpec

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CloneSpec

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

Formats the value using the given formatter.

impl Default for CloneSpec

fn default() -> CloneSpec

Returns the “default value” for a type.