Struct RetrievalFilter 

pub struct RetrievalFilter {
    pub document_sets: Option<Vec<String>>,
    pub metadata_eq: HashMap<String, String>,
}

A query-time retrieval filter: scope results to named document sets and/or require metadata equalities.

• document_sets: None ⇒ no set scoping (every document is eligible — the current/default behavior). Some([]) ⇒ scope to no set (matches nothing); Some(["alpha"]) ⇒ only documents in set "alpha"; a doc in any of the listed sets matches (union).
• metadata_eq ⇒ every (key, value) must be present and equal in the document’s stamped metadata (logical AND across the map). Empty ⇒ no metadata constraint.

An all-default RetrievalFilter (RetrievalFilter::none) matches every document — the no-op that preserves current retrieval behavior.

Fields

document_sets: Option<Vec<String>>

Scope to documents in any of these sets. None ⇒ unscoped (all docs).

metadata_eq: HashMap<String, String>

Require these key == value metadata equalities (all must hold).

Implementations

impl RetrievalFilter

pub fn none() -> Self

The no-op filter: no set scoping, no metadata constraint — matches every document (preserves default retrieval behavior).

pub fn in_sets<I, S>(sets: I) -> Self

where I: IntoIterator<Item = S>, S: Into<String>,

Scope retrieval to the given document sets (a doc in any of them matches).

pub fn with_metadata_eq( self, key: impl Into<String>, value: impl Into<String>, ) -> Self

Add a required metadata equality (builder).

pub fn is_unconstrained(&self) -> bool

Whether this filter imposes no constraint at all (so retrieval is unchanged). Used to short-circuit the over-fetch when there’s nothing to filter on.

pub fn matches(&self, meta: &DocMeta) -> bool

Whether a document with the given DocMeta passes this filter.

True when (a) document_sets is None or the doc is in at least one of the listed sets, and (b) every metadata_eq entry is present and equal in the doc’s metadata.

Trait Implementations

impl Clone for RetrievalFilter

fn clone(&self) -> RetrievalFilter

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RetrievalFilter

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

Formats the value using the given formatter.

impl Default for RetrievalFilter

fn default() -> RetrievalFilter

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for RetrievalFilter

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for RetrievalFilter

impl PartialEq for RetrievalFilter

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

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 RetrievalFilter