Enum termwiz::escape::csi::CSI

pub enum CSI {
    Sgr(Sgr),
    Cursor(Cursor),
    Edit(Edit),
    Mode(Mode),
    Device(Box<Device>),
    Mouse(MouseReport),
    Window(Window),
    Keyboard(Keyboard),
    SelectCharacterPath(CharacterPath, i64),
    Unspecified(Box<Unspecified>),
}

Variants

Sgr(Sgr)

SGR: Set Graphics Rendition. These values affect how the character is rendered.

Cursor(Cursor)

CSI codes that relate to the cursor

Edit(Edit)

Mode(Mode)

Device(Box<Device>)

Mouse(MouseReport)

Window(Window)

Keyboard(Keyboard)

SelectCharacterPath(CharacterPath, i64)

ECMA-48 SCP

Unspecified(Box<Unspecified>)

Unknown or unspecified; should be rare and is rather large, so it is boxed and kept outside of the enum body to help reduce space usage in the common cases.

Implementations

impl CSI

pub fn parse<'a>(
    params: &'a [CsiParam],
    parameters_truncated: bool,
    control: char
) -> impl Iterator<Item = CSI> + 'a

Parse a CSI sequence. Returns an iterator that yields individual CSI actions. Why not a single? Because sequences like CSI [ 1 ; 3 m embed two separate actions but are sent as a single unit. If no semantic meaning is known for a subsequence, the remainder of the sequence is returned wrapped in a CSI::Unspecified container.

Trait Implementations

impl Clone for CSI

fn clone(&self) -> CSI

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CSI

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

Formats the value using the given formatter.

impl Display for CSI

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

Formats the value using the given formatter.

impl PartialEq<CSI> for CSI

fn eq(&self, other: &CSI) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl Eq for CSI

impl StructuralEq for CSI

impl StructuralPartialEq for CSI