Struct QuerySpec 

pub struct QuerySpec {
    pub text: String,
    pub chips: Vec<Chip>,
}

What a query view asks for.

Fields

text: String

The words typed, tokens taken out.

chips: Vec<Chip>

Implementations

impl QuerySpec

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

pub fn parse(input: &str, picked: &[Chip], kinds: &[KindDecl]) -> Self

The query input asks, as typed into the field, with the chips picked beside it: a token naming a filterable field of kinds (artist:ada, artist:"ada lovelace", liked:yes) becomes a typed chip, everything else is text. A token naming no such field, or one with no value yet (artist:), stays text.

pub fn is_empty(&self) -> bool

Nothing is asked: no text and no chip.

pub fn admits(&self, item: &Item) -> bool

Whether item passes the chips: one of each filter’s chosen values (Artist: Ada or Grace), and every filter.

pub fn toggled(&self, chip: &Chip) -> Self

The query with chip chosen too, or taken away when it is chosen. A filter may hold several values; a toggle is on or off.

pub fn cleared(&self, key: &str) -> Self

The query without the chosen values of the filter key; one typed as a token stays, the token in the field takes it away.

pub fn key(&self) -> String

What two equal queries share, however they were typed: the folded words and the chips in a fixed order. Caches are keyed by it.

pub fn refines(&self, earlier: &Self) -> bool

Whether this query narrows earlier: the same chips, and text that goes on from its text. What earlier found that still matches is what this one finds first.

pub fn text_admits(&self, item: &Item, kind: Option<&KindDecl>) -> bool

Whether item matches the text of this query by its searchable fields: every word occurs at a word start in one of them. What a refined query keeps of an earlier answer before its own arrives.

Trait Implementations

impl Clone for QuerySpec

fn clone(&self) -> QuerySpec

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for QuerySpec

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

Formats the value using the given formatter.

impl Default for QuerySpec

fn default() -> QuerySpec

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for QuerySpec

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for QuerySpec

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for QuerySpec

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for QuerySpec

impl StructuralPartialEq for QuerySpec