pub struct HintState {
    hint: Option<Hint>,
    alphabet: String,
    matches: Vec<Match>,
    labels: Vec<Vec<char>>,
    keys: Vec<char>,
}
Expand description

Keyboard regex hint state.

Fields§

§hint: Option<Hint>

Hint currently in use.

§alphabet: String

Alphabet for hint labels.

§matches: Vec<Match>

Visible matches.

§labels: Vec<Vec<char>>

Key label for each visible match.

§keys: Vec<char>

Keys pressed for hint selection.

Implementations§

source§

impl HintState

source

pub fn new<S: Into<String>>(alphabet: S) -> Self

Initialize an inactive hint state.

source

pub fn active(&self) -> bool

Check if a hint selection is in progress.

source

pub fn start(&mut self, hint: Hint)

Start the hint selection process.

source

fn stop(&mut self)

Cancel the hint highlighting process.

source

pub fn update_matches<T>(&mut self, term: &Term<T>)

Update the visible hint matches and key labels.

source

pub fn keyboard_input<T>(&mut self, term: &Term<T>, c: char) -> Option<HintMatch>

Handle keyboard input during hint selection.

source

pub fn labels(&self) -> &Vec<Vec<char>>

Hint key labels.

source

pub fn matches(&self) -> &[Match]

Visible hint regex matches.

source

pub fn update_alphabet(&mut self, alphabet: &str)

Update the alphabet used for hint labels.

Trait Implementations§

source§

impl<'a> From<&'a HintState> for Hint<'a>

source§

fn from(hint_state: &'a HintState) -> Self

Converts to this type from the input type.

Auto Trait Implementations§

Blanket Implementations§

source§

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

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

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

const: unstable · source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

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

const: unstable · source§

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

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

const: unstable · source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

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

const: unstable · 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, U> TryFrom<U> for Twhere U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
const: unstable · source§

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

Performs the conversion.
source§

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

§

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

The type returned in the event of a conversion error.
const: unstable · source§

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

Performs the conversion.