Struct Worktree 

pub struct Worktree { /* private fields */ }

A checkout of one commit, removed when it goes out of scope.

Implementations

impl Worktree

pub fn of( repo: &Path, revspec: &str, beneath: &Path, as_: &str, ) -> Result<Self, Trouble>

Resolves a revspec and lays that commit out under beneath, in a directory called as_.

The name is the caller’s and not the commit’s, because the two sides of a comparison are allowed to be the same commit — asking what a store already holds is a diff of one revision against itself — and two worktrees of one commit under one name is a refusal from git. Detached for the same reason: a branch checked out twice is another one.

pub fn path(&self) -> &Path

pub fn named(&self) -> &str

The short hash, which is what a person reads.

pub fn commit(&self) -> &str

The whole hash, which is what a cache is keyed on: twelve characters is plenty to read and too few to name a stored answer after.

Trait Implementations

impl Drop for Worktree

fn drop(&mut self)

Executes the destructor for this type.