Struct Encoder

Source

pub struct Encoder<'alloc>(/* private fields */);

Expand description

Key encoder that converts key events into terminal escape sequences.

Implementations§

Source §

impl<'alloc> Encoder<'alloc>

Source

pub fn new() -> Result<Self>

Create a new key encoder instance.

Source

pub fn new_with_alloc<'ctx: 'alloc, Ctx>( alloc: &'alloc Allocator<'ctx, Ctx>, ) -> Result<Self>

Create a new key encoder instance with a custom allocator.

See the crate-level documentation regarding custom memory management and lifetimes.

Source

pub fn encode_to_vec( &mut self, event: &Event<'_>, vec: &mut Vec<u8>, ) -> Result<()>

Encode a key event into a terminal escape sequence.

Converts a key event into the appropriate terminal escape sequence based on the encoder’s current options.

Not all key events produce output. For example, unmodified modifier keys typically don’t generate escape sequences. Check the returned Vec to determine if any data was written.

Source

pub fn encode(&mut self, event: &Event<'_>, buf: &mut [u8]) -> Result<usize>

Encode a key event into a terminal escape sequence.

Converts a key event into the appropriate terminal escape sequence based on the encoder’s current options. The sequence is written to the provided buffer.

Not all key events produce output. For example, unmodified modifier keys typically don’t generate escape sequences. Check the returned usize to determine if any data was written.

If the output buffer is too small, this returns Err(Error::OutOfSpace { required }) where required is the required buffer size. The caller can then allocate a larger buffer and call the method again.

Source

pub fn set_options_from_terminal( &mut self, terminal: &Terminal<'_, '_>, ) -> &mut Self

Set encoder options from a terminal’s current state.

Reads the terminal’s current modes and flags and applies them to the encoder’s options. This sets cursor key application mode, keypad mode, alt escape prefix, modifyOtherKeys state, and Kitty keyboard protocol flags from the terminal state.

Note that the macos_option_as_alt option cannot be determined from terminal state and is reset to OptionAsAlt::False by this call. Use Encoder::set_macos_option_as_alt to set it afterward if needed.

Source