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 clipboard_query( query: TerminalClipboardQuery, payload: impl Into<Vec<u8>>, ) -> Self

Creates a typed OSC 52 clipboard query event while retaining its original framed payload for inspection.

pub fn palette_query(index: TerminalPaletteIndex) -> Self

Creates a bounded OSC 4 query for one palette index.

tmux 3.7b canonicalizes both BEL- and ST-terminated pane queries to an ST-terminated sequence before sending them to the outer terminal.

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 const fn palette_query_index(&self) -> Option<TerminalPaletteIndex>

Returns the queried palette index for typed OSC 4 query events.

pub const fn clipboard_query_metadata(&self) -> Option<TerminalClipboardQuery>

Returns typed OSC 52 query metadata for clipboard-query events.

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for TerminalPassthrough