Struct KeyboardInput

pub struct KeyboardInput {
    pub key: i32,
    pub state: i32,
    pub char: u32,
}

060 - Keyboard Input

This message, which must originate from the client on the same stream as the original 030 - Attach message, represents keyboard input from the user.

Fields

key: i32

Required. The physical key that was pressed.

state: i32

Required.

char: u32

A unicode code point for text input, required unless the keypress would not result in a character.

This may be completely unrelated to the physical key, depending on the software keyboard layout on the client side.

Implementations

impl KeyboardInput

pub fn key(&self) -> Key

Returns the enum value of key, or the default if the field is set to an invalid enum value.

pub fn set_key(&mut self, value: Key)

Sets key to the provided enum value.

pub fn state(&self) -> KeyState

Returns the enum value of state, or the default if the field is set to an invalid enum value.

pub fn set_state(&mut self, value: KeyState)

Sets state to the provided enum value.

Trait Implementations

impl Clone for KeyboardInput

fn clone(&self) -> KeyboardInput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for KeyboardInput

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

Formats the value using the given formatter.

impl Default for KeyboardInput

fn default() -> Self

Returns the “default value” for a type.

impl From<KeyboardInput> for MessageType

fn from(v: KeyboardInput) -> Self

Converts to this type from the input type.

impl Message for KeyboardInput

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for KeyboardInput

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

impl StructuralPartialEq for KeyboardInput