Struct DocMeta 

pub struct DocMeta {
    pub document_sets: Vec<String>,
    pub boost: f32,
    pub metadata: HashMap<String, String>,
}

Curation metadata recorded for a stored document: its document-set membership and its retrieval boost, plus the raw metadata map so the RetrievalFilter’s metadata_eq equalities can be evaluated at read.

Parsed from a Document’s metadata at ingest by DocMeta::from_document.

Fields

document_sets: Vec<String>

The named sets this document belongs to (parsed from the comma-separated document_set metadata value; empty when the document is in no set).

boost: f32

The retrieval boost multiplier (parsed from the boost metadata value; DEFAULT_BOOST when absent/malformed). Clamped to ≥ 0.0.

metadata: HashMap<String, String>

The full stamped metadata map, retained so metadata_eq filters can test arbitrary key/value equalities against it.

Implementations

impl DocMeta

pub const DOCUMENT_SET_KEY: &'static str = "document_set"

The document-metadata key under which set membership is stamped. The value is a comma-separated list (e.g. "alpha" or "alpha,beta").

pub const BOOST_KEY: &'static str = "boost"

The document-metadata key under which the numeric boost is stamped (a stringified f32, e.g. "3.0").

pub fn parse_sets(metadata: &HashMap<String, String>) -> Vec<String>

Parse the document-set list from a document_set metadata value: comma-split, trim each name, drop empties. Returns an empty vec when the key is absent or holds only whitespace/commas.

pub fn parse_boost(metadata: &HashMap<String, String>) -> f32

Parse the boost from a boost metadata value. Absent / unparseable / non-finite ⇒ DEFAULT_BOOST; a parsed value is clamped to ≥ 0.0 so a negative boost can only bury a document, never invert ordering.

pub fn from_metadata(metadata: &HashMap<String, String>) -> Self

Build a DocMeta from a stored document’s metadata.

pub fn from_document(doc: &Document) -> Self

Build a DocMeta from a Document (convenience over from_metadata).

pub fn in_set(&self, set: &str) -> bool

Whether this document belongs to the named set.

Trait Implementations

impl Clone for DocMeta

fn clone(&self) -> DocMeta

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DocMeta

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

Formats the value using the given formatter.

impl PartialEq for DocMeta

fn eq(&self, other: &DocMeta) -> 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 StructuralPartialEq for DocMeta