Struct git2::Worktree [−][src]
pub struct Worktree { /* fields omitted */ }
Expand description
An owned git worktree
This structure corresponds to a git_worktree
in libgit2.
Implementations
impl Worktree
[src]
impl Worktree
[src]pub fn open_from_repository(repo: &Repository) -> Result<Worktree, Error>
[src]
pub fn open_from_repository(repo: &Repository) -> Result<Worktree, Error>
[src]Open a worktree of a the repository
If a repository is not the main tree but a worktree, this
function will look up the worktree inside the parent
repository and create a new git_worktree
structure.
pub fn name(&self) -> Option<&str>
[src]
pub fn name(&self) -> Option<&str>
[src]Retrieves the name of the worktree
This is the name that can be passed to repo::Repository::find_worktree to reopen the worktree. This is also the name that would appear in the list returned by repo::Repository::worktrees
pub fn path(&self) -> &Path
[src]
pub fn path(&self) -> &Path
[src]Retrieves the path to the worktree
This is the path to the top-level of the source and not the path to the .git file within the worktree. This path can be passed to repo::Repository::open.
pub fn validate(&self) -> Result<(), Error>
[src]
pub fn validate(&self) -> Result<(), Error>
[src]Validates the worktree
This checks that it still exists on the filesystem and that the metadata is correct
pub fn is_locked(&self) -> Result<WorktreeLockStatus, Error>
[src]
pub fn is_locked(&self) -> Result<WorktreeLockStatus, Error>
[src]Checks if worktree is locked
pub fn prune(
&self,
opts: Option<&mut WorktreePruneOptions>
) -> Result<(), Error>
[src]
pub fn prune(
&self,
opts: Option<&mut WorktreePruneOptions>
) -> Result<(), Error>
[src]Prunes the worktree
pub fn is_prunable(
&self,
opts: Option<&mut WorktreePruneOptions>
) -> Result<bool, Error>
[src]
pub fn is_prunable(
&self,
opts: Option<&mut WorktreePruneOptions>
) -> Result<bool, Error>
[src]Checks if the worktree is prunable