Struct WorktreeCreate 

#[non_exhaustive]
pub struct WorktreeCreate {
    pub path: PathBuf,
    pub branch: String,
    pub base: String,
}

Options for Repo::create_worktree.

Built as WorktreeCreate::new(path, "feature").base("main") — the new-branch name and the fork-point base (both plain strings that a swap would silently accept, creating a branch named like the base) are named across two builder steps, so they can’t be transposed. #[non_exhaustive].

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

Where the new attached worktree (git) / secondary workspace (jj) is created.

branch: String

The new branch (git) / bookmark (jj) to create at the worktree.

base: String

The ref the new branch forks from (git HEAD, jj @, a branch/tag/commit).

Implementations

impl WorktreeCreate

pub fn new( path: impl Into<PathBuf>, branch: impl Into<String>, ) -> WorktreeCreatePartial

Name the worktree path and the new branch to create there; chain base to name the fork point.

Trait Implementations

impl Clone for WorktreeCreate

fn clone(&self) -> WorktreeCreate

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WorktreeCreate

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

Formats the value using the given formatter.

impl Eq for WorktreeCreate

impl PartialEq for WorktreeCreate

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