Struct CloneOptions 

pub struct CloneOptions {

    pub url: String,
    pub dest: PathBuf,
    pub remote_name: String,
    pub environment: Environment,
    pub initial_branch: String,
    pub thread_policy: ThreadPolicy,
    pub depth: Option<u32>,
    pub filter: Option<ObjectFilterSpec>,
    pub auto_filter: bool,
    pub config: Vec<(String, String)>,
    pub branch: Option<String>,
    pub single_branch: Option<bool>,
    pub tags: Option<CloneTags>,
    pub promisor_fetcher: Option<Arc<dyn PromisorFetcher>>,
    pub bare: bool,
    pub checkout: bool,
    pub bundle_cache: Option<PathBuf>,
}

Options for clone.

Fields

url: String

Source URL or path (as passed on the command line).

dest: PathBuf

Directory to create or use for the new repository.

remote_name: String

Remote name to configure (default DEFAULT_REMOTE).

environment: Environment

Process environment for config and reflog identity.

initial_branch: String

Initial branch name used when initializing the empty repo (main).

thread_policy: ThreadPolicy

Global thread policy for fetch pack ingest and the opened repository (--threads).

depth: Option<u32>

Truncate fetched history to this many commits per ref tip (git clone --depth N). Some(1) matches a shallow clone.

filter: Option<ObjectFilterSpec>

Partial-clone object filter applied to the initial fetch and recorded in config.

auto_filter: bool

Pick the filter from the promisor remotes the server advertises and the new repository accepts (Git’s clone --filter=auto), and record remote.<name>.partialclonefilter=auto so later fetches do the same. Ignored when Self::filter is set. Accepting needs promisor.acceptFromServer and the promisor remotes themselves in config, usually through Self::config.

config: Vec<(String, String)>

Config entries written into the new repository right after it is created, before anything is fetched (git clone -c <key>=<value>). Each entry is added, so a key given twice gets both values.

branch: Option<String>

Remote branch or tag to check out (git clone -b / --branch).

single_branch: Option<bool>

Single-branch fetch (git clone --single-branch / --no-single-branch).

None matches Git: depth implies single-branch unless explicitly disabled.

tags: Option<CloneTags>

Tag fetch mode. None uses Git defaults: all tags for full multi-branch clones, tag-following when clone_effective_single_branch is true (explicit --single-branch or shallow clone without --no-single-branch).

promisor_fetcher: Option<Arc<dyn PromisorFetcher>>

Optional on-demand promisor fetcher installed on the opened repository (for checkout prefetch).

bare: bool

Create a bare repository (git clone --bare).

checkout: bool

Populate the index and working tree after fetch (git clone --no-checkout when false).

bundle_cache: Option<PathBuf>

Where bundle downloads are kept, so an interrupted clone resumes its download next time. None skips the server’s bundle-uri bundle. Shallow and partial clones never use one.

Implementations

impl CloneOptions

pub fn new(url: impl Into<String>, dest: PathBuf) -> Self

Options for cloning into dest from url, using the current process environment.