Struct SearchQuery 

pub struct SearchQuery { /* private fields */ }

One query as a provider receives it.

Implementations

impl SearchQuery

pub fn new(text: impl Into<String>) -> SearchQuery

A plain text query with no filters and no scope.

pub fn parse(input: &str, facets: &[Facet]) -> SearchQuery

Split typed input into free text and key:value filters for the declared facets. A token whose key no facet declares stays text, so http://example.org or 12:30 are searched for as typed. Keys match case-insensitively; a quoted value (tag:"two words") may hold spaces.

pub fn with_filter(self, filter: FacetFilter) -> SearchQuery

Add a filter picked as a chip.

pub fn within(self, anchor: impl Into<String>) -> SearchQuery

Narrow the query to the resource anchored at anchor (see ScopeDecl).

pub fn text(&self) -> &str

The free text, with every recognised filter token removed.

pub fn filters(&self) -> &[FacetFilter]

Every applied filter, in the order typed or picked.

pub fn filter_values<'a>( &'a self, key: &'a str, ) -> impl Iterator<Item = &'a str> + 'a

The values applied for key. Values of one key combine as “any of”.

pub fn admits(&self, key: &str, values: &[&str]) -> bool

Whether a hit with values for key passes this query’s filters on that key: always when no value of key is applied.

pub fn scope(&self) -> Option<&str>

The anchor of the resource the query is narrowed to.

pub fn in_scope(&self, anchor: &str) -> bool

Whether the hit anchored at anchor lies inside the query’s scope: always when the query has none.

Trait Implementations

impl Clone for SearchQuery

fn clone(&self) -> SearchQuery

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SearchQuery

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

Formats the value using the given formatter.

impl Default for SearchQuery

fn default() -> SearchQuery

Returns the “default value” for a type.

impl From<&str> for SearchQuery

fn from(text: &str) -> SearchQuery

Converts to this type from the input type.

impl PartialEq for SearchQuery

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

impl StructuralPartialEq for SearchQuery