Struct GitWorktree

pub struct GitWorktree<'a, G>(/* private fields */);

Git methods for dealing with worktrees.

Implementations

impl<'a, G> GitWorktree<'a, G>

where G: GitLike,

pub fn new(git: &'a G) -> Self

pub fn main(&self) -> Result<Worktree>

Get the ‘main’ worktree. There can only be one main worktree, and it contains the common .git directory.

See: https://stackoverflow.com/a/68754000

pub fn container(&self) -> Result<Utf8PathBuf>

Get the worktree container directory.

This is the main worktree’s parent, and is usually where all the other worktrees are cloned as well.

pub fn list(&self) -> Result<Worktrees>

List Git worktrees.

pub fn is_inside(&self) -> Result<bool>

Check if we’re inside a working tree.

This will return false for a bare worktree like a .git directory!

pub fn root(&self) -> Result<Utf8PathBuf>

Get the root of this worktree. Fails if not in a worktree.

pub fn add(&self, path: &Utf8Path, options: &AddWorktreeOpts<'_>) -> Result<()>

pub fn add_command( &self, path: &Utf8Path, options: &AddWorktreeOpts<'_>, ) -> Command

pub fn rename(&self, from: &Utf8Path, to: &Utf8Path) -> Result<()>

pub fn repair( &self, paths: impl IntoIterator<Item = impl AsRef<OsStr>> + Debug, ) -> Result<()>

impl<'a, C> GitWorktree<'a, AppGit<'a, C>>

where C: AsRef<Utf8Path>,

pub fn dirname_for<'b>(&self, branch: &'b str) -> Cow<'b, str>

The directory name, nested under the worktree parent directory, where the given branch’s worktree will be placed.

E.g. to convert a repo ~/puppy with default branch main, this will return main, to indicate a worktree to be placed in ~/puppy/main.

pub fn path_for(&self, branch: &str) -> Result<Utf8PathBuf>

Get the full path for a new worktree with the given branch name.

This appends the Self::dirname_for to the Self::container.

pub fn resolve_unique_names( &self, opts: ResolveUniqueNameOpts<'_>, ) -> Result<FxHashMap<Utf8PathBuf, RenamedWorktree>>

Resolves a set of worktrees into a map from worktree paths to unique names.

pub fn preferred_branch( &self, preferred_branch: Option<&BranchRef>, worktrees: Option<&Worktrees>, ) -> Result<Option<Worktree>>

Get the worktree for the preferred branch, if any.

pub fn find_some(&self) -> Result<Utf8PathBuf>

Get the path to some worktree.

This prefers, in order:

1. The current worktree.
2. The worktree for the default branch.
3. Any non-bare worktree.
4. A bare worktree.

Trait Implementations

impl<G> Debug for GitWorktree<'_, G>

where G: GitLike,

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

Formats the value using the given formatter.