Enum Checkout 

pub enum Checkout {
    Repository,
    Linked,
    Submodule,
}

What the .git at a work tree root actually is.

is_work_tree_root deliberately collapses all three, which is right for the safety model’s question — “is there a checkout here” — and wrong for the only question where the difference decides whether a directory is disposable.

A linked work tree is the one kind that holds no history of its own. Its commits go to the repository’s object store and its branch is an ordinary ref there, so deleting the directory costs the checked-out files and nothing else — verified rather than assumed: a commit made in a linked work tree is still readable through its branch after the directory is removed outright. A Repository is the object store, and a Submodule is a checkout the superproject’s index points at, which is a different promise from “somewhere to do some work”.

Variants

Repository

.git is a directory: the repository itself, holding every object and ref under it.

Linked

.git is a file pointing into another repository’s worktrees/, which is where the objects and the branch actually live.

Submodule

.git is a file pointing into a superproject’s modules/.

Trait Implementations

impl Clone for Checkout

fn clone(&self) -> Checkout

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for Checkout

impl Debug for Checkout

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

Formats the value using the given formatter.

impl Eq for Checkout

impl PartialEq for Checkout

fn eq(&self, other: &Checkout) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for Checkout