Enum Unit 

pub enum Unit {
    File {
        path: String,
    },
    Section {
        file: String,
        anchor: String,
    },
    Symbol {
        id: String,
    },
    Directory {
        path: String,
    },
    Crate {
        id: String,
    },
    Module {
        id: String,
    },
}

An authority unit: the granularity at which a spec claims ownership.

Serializes internally-tagged on kind (e.g. { "kind": "file", "path": ... }). Deserializes from that tagged map, a bare string (= a file unit), or a { unit: <unit> } wrapper (spec 015 sugar), so authors can write establishes: ["src/lib.rs"] or establishes: [{ unit: "src/lib.rs" }] interchangeably; all three normalize to the same unit.

Variants

File

A file path (bare string shorthand resolves here). A trailing / denotes the directory subtree rooted at path.

Fields

path: String

Section

A named section within a file: a Makefile target, a Markdown heading slug, a region: marker, or a CI jobs.<name>.

Fields

file: String

anchor: String

Symbol

A symbol (function / type / export), resolved by the indexer via tree-sitter (Rust .rs and TypeScript .ts/.tsx).

Fields

id: String

Directory

A directory subtree, named explicitly ({ kind: directory, path }). The subtree-prefix resolution is identical to a trailing-slash file unit; the distinct kind preserves the author’s intent across the round-trip (spec 017). Resolves to the directory path; the gate prefix-matches it.

Fields

path: String

Crate

A compilation unit by its manifest name (Cargo [package].name or npm package.json:name), resolved against the discovered package inventory to the package directory subtree (spec 017).

Fields

id: String

Module

A module by its ::-qualified path (e.g. my_crate::serialization), resolved by the indexer’s Rust module index: file-modules (whole file) and top-level inline mod blocks (line-span) (spec 017).

Fields

id: String

Implementations

impl Unit

pub fn file(path: impl Into<String>) -> Self

A file unit from a path (the bare-string shorthand target).

pub fn is_directory_subtree(&self) -> bool

True if this unit resolves to a directory subtree: a file unit whose path ends /, or an explicit Unit::Directory (spec 017).

Trait Implementations

impl Clone for Unit

fn clone(&self) -> Unit

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Unit

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Unit

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for Unit

impl PartialEq for Unit

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Unit

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Unit