Struct WorktreeCreateOpts 

pub struct WorktreeCreateOpts {
    pub branch: String,
    pub path: PathBuf,
    pub start_point: Option<String>,
    pub force_branch: bool,
    pub detach: bool,
}

Options for creating a new worktree.

Fields

branch: String

Branch name to create (or check out if it already exists).

path: PathBuf

Target path for the new worktree. Can be absolute or relative to the repository root.

start_point: Option<String>

Starting point for the new branch (default: HEAD).

force_branch: bool

If true, create a new branch even if one with the same name exists (forces -B instead of -b). Default: false.

detach: bool

If true, detach HEAD in the new worktree instead of creating a branch. Default: false.

Implementations

impl WorktreeCreateOpts

pub fn feature_branch(branch: &str, repo_root: &Path) -> Self

Build options for a simple feature-branch worktree.

The path is derived by appending the branch name (with / → -) as a sibling directory next to the repo root.

pub fn hotfix(branch: &str, start_point: &str, repo_root: &Path) -> Self

Build options for a hotfix worktree based on a specific commit/tag.

Trait Implementations

impl Clone for WorktreeCreateOpts

fn clone(&self) -> WorktreeCreateOpts

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WorktreeCreateOpts

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for WorktreeCreateOpts

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for WorktreeCreateOpts

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.