Struct WorktreeAdd 

#[non_exhaustive]
pub struct WorktreeAdd {
    pub path: PathBuf,
    pub new_branch: Option<String>,
    pub commitish: Option<String>,
    pub no_checkout: bool,
}

Options for GitApi::worktree_add (git worktree add).

#[non_exhaustive], so build it through WorktreeAdd::checkout / WorktreeAdd::create_branch 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.

path: PathBuf

Filesystem path for the new worktree.

new_branch: Option<String>

Create and check out this new branch (-b <name>); None checks out an existing ref.

commitish: Option<String>

The commit/branch to base the worktree on; None defaults to HEAD.

no_checkout: bool

Register the worktree without populating its files (--no-checkout) — the caller fills the working tree itself (e.g. a copy-on-write clone).

Implementations

impl WorktreeAdd

pub fn checkout(path: impl Into<PathBuf>, commitish: impl Into<String>) -> Self

A worktree at path checking out an existing commitish (e.g. a branch): git worktree add <path> <commitish>.

pub fn create_branch( path: impl Into<PathBuf>, name: impl Into<String>, commitish: impl Into<String>, ) -> Self

A worktree at path creating a new branch name based on commitish: git worktree add -b <name> <path> <commitish>.

pub fn no_checkout(self) -> Self

Register the worktree without checking out its files (--no-checkout), for a caller that populates the working tree itself.

Trait Implementations

impl Clone for WorktreeAdd

fn clone(&self) -> WorktreeAdd

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WorktreeAdd

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

Formats the value using the given formatter.