Struct git_repository::Worktree

pub struct Worktree<'repo> { /* private fields */ }

A worktree checkout containing the files of the repository in consumable form.

Implementations

impl<'repo> Worktree<'repo>

pub fn open_index(&self) -> Result<File, Error>

A shortcut to crate::Repository::open_index().

pub fn index(&self) -> Result<Index, Error>

A shortcut to crate::Repository::index().

impl<'repo> Worktree<'repo>

pub fn excludes<'a>(
    &self,
    index: &'a State,
    overrides: Option<MatchGroup<Ignore>>
) -> Result<Cache<'a>, Error>

Configure a file-system cache checking if files below the repository are excluded.

This takes into consideration all the usual repository configuration.

impl<'repo> Worktree<'repo>

Access

pub fn base(&self) -> &'repo Path

Read the location of the checkout, the base of the work tree

pub fn is_main(&self) -> bool

Return true if this worktree is the main worktree associated with a non-bare git repository.

It cannot be removed.

pub fn is_locked(&self) -> bool

Return true if this worktree cannot be pruned, moved or deleted, which is useful if it is located on an external storage device.

Always false for the main worktree.

pub fn lock_reason(&self) -> Option<BString>

Provide a reason for the locking of this worktree, if it is locked at all.

Note that we squelch errors in case the file cannot be read in which case the reason is an empty string.

pub fn id(&self) -> Option<&BStr>

Return the ID of the repository worktree, if it is a linked worktree, or None if it’s a linked worktree.