Skip to main content

WorktreeManager

Struct WorktreeManager 

Source
pub struct WorktreeManager { /* private fields */ }
Expand description

Manages git worktree operations for a repository.

All commands are run via the git CLI in async subprocesses.

Implementations§

Source§

impl WorktreeManager

Source

pub fn new(repo_root: &Path) -> Result<Self>

Create a manager for the repository at repo_root.

Verifies that the directory is inside a git repository.

Source

pub fn for_current_repo() -> Result<Self>

Create a manager by auto-detecting the git repo from the current directory (or any directory).

Source

pub fn repo_root(&self) -> &Path

The repository root path.

Source

pub async fn create(&self, opts: &WorktreeCreateOpts) -> Result<WorktreeInfo>

Create a new worktree with the given options.

Source

pub async fn create_worktree( &self, branch: &str, target_path: &Path, start_point: Option<&str>, ) -> Result<WorktreeInfo>

Create a worktree at target_path that checks out branch.

If branch doesn’t exist yet, it is created from start_point (or HEAD).

Source

pub async fn list(&self) -> Result<WorktreeList>

List all worktrees in the repository.

Uses git worktree list --porcelain for machine-readable output.

Source

pub async fn remove(&self, path: &Path, force: bool) -> Result<()>

Remove a worktree by its path.

Fails if the worktree has uncommitted changes unless force is true.

Source

pub async fn remove_by_branch(&self, branch: &str, force: bool) -> Result<()>

Remove a worktree by branch name.

Finds the worktree with the given branch and removes it.

Source

pub async fn prune(&self) -> Result<()>

Prune deleted worktrees (clean up stale administrative files).

Source

pub async fn remove_and_delete_branch( &self, branch: &str, force: bool, ) -> Result<()>

Remove a worktree and delete its branch.

Source

pub async fn force_remove_and_delete_branch(&self, branch: &str) -> Result<()>

Remove a worktree and force-delete its branch (even if unmerged).

Source

pub async fn merge( &self, source_branch: &str, target_branch: &str, ) -> Result<MergeResult>

Merge a worktree’s branch into a target branch.

This checks out target_branch in the main worktree, merges source_branch, and returns the result.

Source

pub async fn merge_and_remove( &self, source_branch: &str, target_branch: &str, ) -> Result<MergeResult>

Merge a worktree’s branch into target_branch, then remove the worktree and delete the source branch.

On merge conflict, the worktree is NOT removed — the caller must resolve conflicts and then call remove_and_delete_branch.

Source

pub async fn branch( &self, branch: &str, target_path: &Path, start_point: Option<&str>, ) -> Result<WorktreeInfo>

Create a new branch + worktree in one operation.

Equivalent to git worktree add -b <branch> <path> [<start-point>].

Source

pub async fn feature(&self, branch: &str) -> Result<WorktreeInfo>

Create a feature worktree: sibling directory named after the branch.

Source

pub async fn hotfix( &self, branch: &str, start_point: &str, ) -> Result<WorktreeInfo>

Create a hotfix worktree: branching off a specific start point.

Source

pub async fn is_dirty(&self, worktree_path: &Path) -> Result<bool>

Check whether a worktree has uncommitted changes.

Source

pub async fn current_branch(&self, worktree_path: &Path) -> Result<String>

Get the current branch name of a worktree.

Source

pub async fn head_commit(&self, worktree_path: &Path) -> Result<String>

Get the commit SHA of HEAD in a worktree.

Source

pub async fn branch_exists(&self, branch: &str) -> Result<bool>

Check if a branch name already exists in the repo.

Trait Implementations§

Source§

impl Clone for WorktreeManager

Source§

fn clone(&self) -> WorktreeManager

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for WorktreeManager

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more