Struct Encoder 

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

Mouse encoder that converts normalized mouse events into terminal escape sequences.

Implementations

impl<'alloc> Encoder<'alloc>

pub fn new() -> Result<Self>

Create a new mouse encoder instance.

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

Create a new mouse encoder instance with a custom allocator.

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

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. The provided Vec byte buffer will be grown automatically if more capacity is needed.

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.

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

Encode a mouse event into a terminal escape sequence.

Not all mouse events produce output. In such cases this returns Ok(0).

If the output buffer is too small, this returns Err(Error::OutOfSpace { required }) where required is the required size.

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

Set encoder options from a terminal’s current state.

This sets tracking mode and output format from terminal state. It does not modify size or any-button state.

pub fn set_tracking_mode(&mut self, value: TrackingMode) -> &mut Self

Set mouse tracking mode.

pub fn set_format(&mut self, value: Format) -> &mut Self

Set mouse output format.

pub fn set_size(&mut self, value: EncoderSize) -> &mut Self

Set renderer size context.

pub fn set_any_button_pressed(&mut self, value: bool) -> &mut Self

Set whether any mouse button is currently pressed.

pub fn set_track_last_cell(&mut self, value: bool) -> &mut Self

Set whether to enable motion deduplication by last cell.

pub fn reset(&mut self)

Reset internal encoder state.

This clears motion deduplication state (last tracked cell).

Trait Implementations

impl<'alloc> Debug for Encoder<'alloc>

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

Formats the value using the given formatter.

impl Drop for Encoder<'_>

fn drop(&mut self)

Executes the destructor for this type.