Enum Worktrees 

pub enum Worktrees {
    Skip,
    Include,
}

Whether a roots scan hosts the linked git worktrees it walks over.

A roots entry is a discovery mechanism, and a second checkout of a repository you either already have or deliberately did not add is not a discovery: hosting it presents one repository as N peer projects at N revisions, which triple-counts its symbols in every metric and lets a workspace-scoped retrieval return the same file at three revisions as three independent sources (issue #837).

Deliberately not a bool parameter, and deliberately not defaulted at this layer: scan_root and discover_repos_under take it by value so that every one of the nine call sites across the CLI and config resolution has to state its answer at the call. This rule previously existed in one place and was read by many, which is the shape that let #806’s five markdown-link scanners and #787’s two walkers drift; a defaulted argument would restore exactly that — a new caller inheriting a policy it never considered.

Deliberately not #[non_exhaustive]: the set is closed by the question, not by today’s implementation. A discovered directory either is hosted or it is not, and there is no third answer to give — a future “host it but label it as a worktree of its parent” (issue #837, option 2) is a property of the hosted project rather than a third outcome of this scan, so it would arrive on RootScan and leave this pair intact. Closing it lets every caller match both arms and be told by the compiler when the policy grows a case, which is the whole reason the parameter is not a bool.

Variants

Skip

Walk past a linked worktree, recording it in RootScan::worktrees so the caller can say what it skipped. The default, and what a roots entry gets unless the workspace declaring it sets include_worktrees = true.

Include

Host a linked worktree as an ordinary member, as every roots scan did before #837. The opt-in, and what an explicit repos = [...] entry gets by construction — an explicit path is never discovered, so it never reaches this scan at all.

Trait Implementations

impl Clone for Worktrees

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Worktrees

impl Debug for Worktrees

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

Formats the value using the given formatter.

impl Default for Worktrees

fn default() -> Self

Returns the “default value” for a type.

impl Eq for Worktrees

impl Hash for Worktrees

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Worktrees

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl PartialEq for Worktrees

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for Worktrees

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralPartialEq for Worktrees