Struct TerminalPassthrough 

pub struct TerminalPassthrough { /* private fields */ }

Opaque terminal command that must be forwarded to a capable outer terminal.

Implementations

impl TerminalPassthrough

pub fn raw(cursor_x: u32, cursor_y: u32, payload: impl Into<Vec<u8>>) -> Self

Creates an opaque passthrough event at a pane-local cursor position.

pub fn clipboard(payload: impl Into<Vec<u8>>) -> Self

Creates an OSC 52 clipboard passthrough event.

pub fn kitty_graphics( cursor_x: u32, cursor_y: u32, payload: impl Into<Vec<u8>>, ) -> Self

Creates a Kitty graphics passthrough event at a pane-local cursor position.

pub fn sixel(cursor_x: u32, cursor_y: u32, payload: impl Into<Vec<u8>>) -> Self

Creates a SIXEL passthrough event at a pane-local cursor position.

pub const fn kind(&self) -> TerminalPassthroughKind

Returns the passthrough protocol family.

pub const fn cursor_x(&self) -> u32

Returns the pane-local cursor column captured when the sequence arrived.

pub const fn cursor_y(&self) -> u32

Returns the pane-local cursor row captured when the sequence arrived.

pub fn payload(&self) -> &[u8]

Returns the opaque protocol payload without escape framing.

pub fn render_sequence(&self) -> Vec<u8>

Renders the passthrough as an outer-terminal escape sequence.

Trait Implementations

impl Clone for TerminalPassthrough

fn clone(&self) -> TerminalPassthrough

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TerminalPassthrough

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

Formats the value using the given formatter.

impl Eq for TerminalPassthrough

impl PartialEq for TerminalPassthrough

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