Struct alacritty::display::hint::HintState

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

Keyboard regex hint state.

Fields

hint: Option<Hint>

Hint currently in use.

alphabet: String

Alphabet for hint labels.

matches: RegexMatches

Visible matches.

labels: Vec<Vec<char>>

Key label for each visible match.

keys: Vec<char>

Keys pressed for hint selection.

Implementations

impl HintState

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

Initialize an inactive hint state.

pub fn active(&self) -> bool

Check if a hint selection is in progress.

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

Start the hint selection process.

fn stop(&mut self)

Cancel the hint highlighting process.

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

Update the visible hint matches and key labels.

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

Handle keyboard input during hint selection.

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

Hint key labels.

pub fn matches(&self) -> &RegexMatches

Visible hint regex matches.

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

Update the alphabet used for hint labels.

Trait Implementations

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

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

Performs the conversion.