Struct Descriptor 

pub struct Descriptor {
    pub title: Option<CompactString>,
    pub keywords: SmallVec<[CompactString; 8]>,
    pub headings: SmallVec<[CompactString; 8]>,
    pub heading_levels: SmallVec<[u8; 8]>,
    pub tags: SmallVec<[CompactString; 8]>,
    pub lang: Option<CompactString>,
    pub snippet: CompactString,
    pub embed_text: String,
    pub bm25_terms: Vec<CompactString>,
    pub links: Vec<CompactString>,
}

The distilled, indexable form of a document.

Fields

title: Option<CompactString>

Display title, if found.

keywords: SmallVec<[CompactString; 8]>

Top keywords/topics (most frequent discriminative terms).

headings: SmallVec<[CompactString; 8]>

Section headings (H1–H3 / ATX), high-signal for retrieval.

heading_levels: SmallVec<[u8; 8]>

Heading depths parallel to headings (1 = H1 …); empty when the extractor cannot tell (code/plain text), in which case consumers fall back to position-derived depths.

tags: SmallVec<[CompactString; 8]>

Structured tags (currently URL path components) for filtering.

lang: Option<CompactString>

Detected language tag, if any.

snippet: CompactString

A short display snippet.

embed_text: String

The distilled text handed to the embedder.

bm25_terms: Vec<CompactString>

Normalized BM25 terms (also defines document length).

links: Vec<CompactString>

Outbound link hrefs (raw, unresolved) discovered in the document.

Implementations

impl Descriptor

pub fn is_empty(&self) -> bool

Whether this descriptor carries no indexable content (no body/title terms). URL-path tags alone do not count as content.

pub fn into_document( self, url: Url, kind: ResourceKind, content_hash: u64, vector: Vec<f32>, ) -> Document

Convert into an index Document, pairing with a resolved URL, content hash, and embedding vector.

Freshness fields (fetched_at_ms, etag, pinned) default to unset/unpinned; callers that maintain a persisted knowledge base (the facade) set them on the returned document before upserting.

Trait Implementations

impl Clone for Descriptor

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Descriptor

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

Formats the value using the given formatter.

impl Default for Descriptor

fn default() -> Self

Returns the “default value” for a type.