Struct RetrievalPlan 

pub struct RetrievalPlan {
    pub query: String,
    pub source_scope: Option<String>,
    pub limit: usize,
    pub freshness: FreshnessPolicy,
}

Validated retrieval request with bounded result count.

Fields

query: String

source_scope: Option<String>

limit: usize

freshness: FreshnessPolicy

Implementations

impl RetrievalPlan

pub fn new( query: impl Into<String>, source_scope: Option<String>, limit: usize, freshness: FreshnessPolicy, ) -> Result<Self, RetrievalPlanError>

Validates query text and result limits.

Trait Implementations

impl Clone for RetrievalPlan

fn clone(&self) -> RetrievalPlan

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RetrievalPlan

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

Formats the value using the given formatter.

impl Eq for RetrievalPlan

impl PartialEq for RetrievalPlan

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