Skip to main content

SearchSchema

Struct SearchSchema 

Source
pub struct SearchSchema {
    pub text_search: bool,
    pub max_page_size: usize,
    pub fields: BTreeMap<String, SearchField>,
}
Expand description

Provider-defined filter fields and search limits, also usable to generate help. For example, an adapter can expose an exact publishing-account filter:

use cherenkov_model_data::discovery::*;
use std::collections::BTreeMap;

let schema = SearchSchema {
    text_search: false,
    max_page_size: 100,
    fields: BTreeMap::from([("author".to_owned(), SearchField {
        description: "Publishing account or organization".to_owned(),
        value_type: ValueType::String,
        operators: vec![FilterOperator::Equal],
    })]),
};

Return this schema in DiscoveryCapabilities::search. Field types and operators validate operands; the adapter implements their matching behavior.

Fields§

§text_search: bool

Whether the provider accepts free-text queries.

§max_page_size: usize

Maximum number of results requested in one page.

§fields: BTreeMap<String, SearchField>

Filter definitions keyed by the provider’s field names, such as author.

Implementations§

Source§

impl SearchSchema

Source

pub fn validate(&self, query: &SearchQuery) -> Result<()>

Reject unsupported text, unknown fields, unsupported operators, and invalid operands. Validation does not perform I/O or interpret provider metadata.

Trait Implementations§

Source§

impl Clone for SearchSchema

Source§

fn clone(&self) -> SearchSchema

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for SearchSchema

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for SearchSchema

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for SearchSchema

Source§

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

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.