Skip to main content

WorktreeManager

Struct WorktreeManager 

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

Manages git worktrees for a project.

Implementations§

Source§

impl WorktreeManager

Source

pub fn new(project_dir: impl Into<PathBuf>) -> Self

Create a new manager for the given project directory.

Worktrees are stored under ~/.opendev/data/worktree/.

Source

pub fn with_base( project_dir: impl Into<PathBuf>, worktree_base: impl Into<PathBuf>, ) -> Self

Create a new manager with a custom worktree base directory.

Primarily useful for tests.

Source

pub fn project_dir(&self) -> &Path

Get the project directory.

Source

pub fn worktree_base(&self) -> &Path

Get the worktree base directory.

Source

pub async fn create( &mut self, name: Option<&str>, branch: Option<&str>, base_branch: &str, ) -> Result<WorktreeInfo, WorktreeError>

Create a new worktree.

  • name: worktree name (auto-generated if None)
  • branch: branch name (defaults to worktree-{name})
  • base_branch: base commit/branch to start from (defaults to "HEAD")
Source

pub async fn list(&self) -> Result<Vec<WorktreeInfo>, WorktreeError>

List all worktrees for the project (from git worktree list --porcelain).

Source

pub async fn remove( &mut self, name: &str, force: bool, ) -> Result<(), WorktreeError>

Remove a worktree by name (or absolute path).

Source

pub async fn cleanup(&self) -> Result<String, WorktreeError>

Clean up stale/prunable worktree references.

Source

pub fn tracked(&self) -> &HashMap<String, WorktreeInfo>

Get tracked worktrees in session state.

Source

pub fn track(&mut self, name: String, info: WorktreeInfo)

Track a worktree in session state.

Source

pub fn untrack(&mut self, name: &str) -> Option<WorktreeInfo>

Untrack a worktree from session state.

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> 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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + 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: Sized + 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, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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