Struct ScanScope 

pub struct ScanScope {
    pub max_depth: Option<usize>,
    pub follow_symlinks: bool,
    pub one_filesystem: bool,
    pub hidden_fingerprint: u64,
    pub exclude_special: bool,
    pub population: IgnoredEntries,
    pub ignore_rules_fingerprint: u64,
    pub type_rules_fingerprint: u64,
    pub reducers_fingerprint: u64,
}

Semantic inputs that decide which entries and derived values belong in an index.

Operational settings such as producer batch size are intentionally absent. A snapshot may be reused only when this value matches exactly.

Fields

max_depth: Option<usize>

Maximum retained relative depth, or unlimited when absent.

follow_symlinks: bool

Whether directory symlinks are followed.

one_filesystem: bool

Whether traversal stays on the root filesystem.

hidden_fingerprint: u64

Identity of leading-dot component admission and its exact-name allowlist.

exclude_special: bool

Whether filesystem objects outside files, directories, and symlinks are excluded.

population: IgnoredEntries

Ignored population retained by this scan.

ignore_rules_fingerprint: u64

Identity of the compiled ignore policy.

type_rules_fingerprint: u64

Identity of the compiled type-classification policy.

reducers_fingerprint: u64

Identity of the enabled reducer set.

Implementations

impl ScanScope

pub const fn observes_controls(self) -> bool

Whether an index of this scope observed .gitignore control state.

False when the scan ran with ScanConfig::read_controls off: no control file was read and no entry was classified. Such an index cannot say whether an entry is ignored, so Index::is_ignored, Index::controls, and the partition accessors (Index::partition_total and its per-directory forms) refuse with Error::ControlStateNotObserved rather than answer “not ignored” for everything, and a shared ChildSnapshot carries no ignore bit or partitions.

The ignore-rules fingerprint is derived from the scope’s ControlTierIdentity, which reserves zero for a tier that observed nothing; a caller holding the identity asks it directly.

pub const fn entry_scope(self) -> EntryScope

The part of this validated scope that determines retained filesystem facts.

pub const fn semantic_identity(self) -> SemanticIdentity

The part of this validated scope that determines classifications and roll-ups.

Trait Implementations

impl Clone for ScanScope

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 ScanScope

impl Debug for ScanScope

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

Formats the value using the given formatter.

impl Default for ScanScope

fn default() -> Self

Returns the “default value” for a type.

impl Eq for ScanScope

impl Hash for ScanScope

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 PartialEq for ScanScope

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ScanScope