Struct KeyMsg 

pub struct KeyMsg {
    pub key_type: KeyType,
    pub runes: Vec<char>,
    pub alt: bool,
    pub paste: bool,
}

Keyboard key event message.

KeyMsg is sent to the program’s update function when a key is pressed.

Example

use bubbletea::{KeyMsg, KeyType};

fn handle_key(key: KeyMsg) {
    match key.key_type {
        KeyType::Enter => println!("Enter pressed"),
        KeyType::Runes => println!("Typed: {:?}", key.runes),
        _ => {}
    }
}

Fields

key_type: KeyType

The type of key pressed.

runes: Vec<char>

For KeyType::Runes, the characters typed.

alt: bool

Whether Alt was held.

paste: bool

Whether this came from a paste operation.

Implementations

impl KeyMsg

pub fn from_type(key_type: KeyType) -> Self

Create a new key message from a key type.

pub fn from_char(c: char) -> Self

Create a new key message from a character.

pub fn from_runes(runes: Vec<char>) -> Self

Create a new key message from multiple characters (e.g., from IME).

pub fn with_alt(self) -> Self

Set the alt modifier.

pub fn with_paste(self) -> Self

Set the paste flag.

Trait Implementations

impl Clone for KeyMsg

fn clone(&self) -> KeyMsg

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for KeyMsg

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

Formats the value using the given formatter.

impl Display for KeyMsg

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

Formats the value using the given formatter.

impl PartialEq for KeyMsg

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

impl StructuralPartialEq for KeyMsg