Enum r3bl_rs_utils::InputEvent

#[non_exhaustive]
pub enum InputEvent {
    Keyboard(KeyPress),
    Resize(Size),
    Mouse(MouseInput),
    Focus(FocusEvent),
    Paste(String),
}

Please see KeyPress for more information about handling keyboard input.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Keyboard(KeyPress)

Resize(Size)

Mouse(MouseInput)

Focus(FocusEvent)

Paste(String)

A string that was pasted into the terminal. Only emitted if bracketed-paste feature has been enabled for crossterm in Cargo.toml.

Implementations

impl InputEvent

pub fn matches_keypress(&self, other: KeyPress) -> bool

pub fn matches_any_of_these_keypresses(&self, others: &[KeyPress]) -> bool

impl InputEvent

pub fn matches(&self, exit_keys: &[InputEvent]) -> bool

Checks to see whether the input_event matches any of the exit_keys. Returns true if it does and false otherwise.

Trait Implementations

impl Clone for InputEvent

fn clone(&self) -> InputEvent

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for InputEvent

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for InputEvent

fn deserialize<__D>( __deserializer: __D ) -> Result<InputEvent, <__D as Deserializer<'de>>::Error>where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for InputEvent

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

For ToString.

impl From<(u16, u16)> for InputEvent

fn from(size: (u16, u16)) -> InputEvent

Typecast / convert [(u16, u16)] to InputEvent::Resize.

impl From<MouseEvent> for InputEvent

fn from(mouse_event: MouseEvent) -> InputEvent

Typecast / convert MouseEvent to InputEvent::Mouse.

impl PartialEq<InputEvent> for InputEvent

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for InputEvent

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

Serialize this value into the given Serde serializer.

impl TryFrom<&InputEvent> for EditorEvent

type Error = String

The type returned in the event of a conversion error.

fn try_from( input_event: &InputEvent ) -> Result<EditorEvent, <EditorEvent as TryFrom<&InputEvent>>::Error>

Performs the conversion.

impl TryFrom<Event> for InputEvent

fn try_from( event: Event ) -> Result<InputEvent, <InputEvent as TryFrom<Event>>::Error>

Typecast / convert Event to InputEvent.

type Error = ()

The type returned in the event of a conversion error.

impl TryFrom<KeyEvent> for InputEvent

type Error = ()

The type returned in the event of a conversion error.

fn try_from( key_event: KeyEvent ) -> Result<InputEvent, <InputEvent as TryFrom<KeyEvent>>::Error>

Performs the conversion.

impl Eq for InputEvent

impl StructuralEq for InputEvent

impl StructuralPartialEq for InputEvent