Struct FilterState 

pub struct FilterState { /* private fields */ }

A query and the candidates that match it, best first.

Candidates are strings to search; a match is a candidate’s index and the character positions that matched, for highlight. With an empty query every candidate matches, in order, except those hidden (set_hidden): a collapsed tree node’s children stay out of the list until something is typed.

Implementations

impl FilterState

pub fn new<I, S>(candidates: I) -> FilterState

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

Filter candidates, with nothing typed yet.

pub fn set_candidates<I, S>(&mut self, candidates: I)

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

Replace the candidates and filter them again.

pub fn candidates(&self) -> &[String]

pub fn set_hidden(&mut self, hidden: Vec<bool>)

Leave these candidates out while the query is empty (true hides). Takes effect on the next refilter.

pub fn set_tree(&mut self, parents: Option<Vec<Option<usize>>>)

Filter as a tree (#428): parents[i] is candidate i’s parent, and candidates come in tree order, each parent before its children. While a query is typed, what matches keeps its ancestors, so a match shows where it is: the list is the matches and their ancestors in tree order, the ancestors marked as context with nothing highlighted, and best is where the best match is. None goes back to a flat ranking. Takes effect on the next refilter.

pub fn set_highlight_limits(&mut self, limits: Vec<usize>)

Highlight at most the first limits[i] characters of candidate i: for a candidate searched with more than its label (a description), so only the label highlights. Takes effect on the next refilter.

pub fn query(&self) -> &str

What is typed.

pub fn query_mut(&mut self) -> &mut String

The query, to edit in place; call refilter after.

pub fn is_filtering(&self) -> bool

pub fn set_query(&mut self, query: impl Into<String>)

Replace the query and filter again.

pub fn push(&mut self, c: char)

Type c.

pub fn push_str(&mut self, text: &str)

Type text (a paste: see pasted).

pub fn pop(&mut self) -> bool

Delete the last character; false when there was none.

pub fn clear(&mut self)

Clear the query.

pub fn refilter(&mut self)

Match the candidates against the query again.

pub fn is_context(&self, position: usize) -> bool

Whether the match at position is only there as an ancestor of a match (set_tree): drawn dim, not picked first.

pub fn best(&self) -> Option<usize>

The position of the best match: the first, unless a tree keeps ancestors above it.

pub fn matches(&self) -> &[(usize, Vec<usize>)]

The matches, best first: candidate indices and the positions to highlight.

pub fn len(&self) -> usize

How many candidates match.

pub fn is_empty(&self) -> bool

pub fn index(&self, position: usize) -> Option<usize>

The candidate at position in the matches.

pub fn position_of(&self, index: usize) -> Option<usize>

Where candidate index is in the matches, if it matches.

Trait Implementations

impl Clone for FilterState

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FilterState

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

Formats the value using the given formatter.

impl Default for FilterState

fn default() -> Self

Returns the “default value” for a type.

impl Eq for FilterState

impl PartialEq for FilterState

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for FilterState