Skip to main content

Token

Enum Token 

Source
pub enum Token {
    Text(String),
    Control(u8),
    Csi {
        private: Option<char>,
        params: Vec<u16>,
        intermediates: Vec<u8>,
        final_byte: char,
    },
    Esc {
        intermediates: Vec<u8>,
        final_byte: u8,
    },
    Osc(String),
    Other {
        intro: u8,
        data: Vec<u8>,
    },
}
Expand description

One parsed unit of terminal output, owned.

Event is the same information borrowed; this is what Parser::feed builds from it.

Variants§

§

Text(String)

A run of printable text (valid UTF-8; invalid input bytes become U+FFFD). Runs are flushed at each control byte and at the end of each feed call, so adjacent Text tokens are equivalent to one.

§

Control(u8)

A C0 control byte executed on its own (BEL, BS, TAB, LF, CR, …) or DEL. ESC never appears here; it introduces a sequence.

§

Csi

ESC [ ...: a CSI sequence with an optional private marker (?, >, <, =), numeric parameters, intermediate bytes, and the final byte. Missing parameters parse as 0; colon sub-parameters are truncated.

Fields

§private: Option<char>
§params: Vec<u16>
§intermediates: Vec<u8>
§final_byte: char
§

Esc

A non-CSI escape: ESC + optional intermediates + final byte (e.g. ESC 7, ESC ( B).

Fields

§intermediates: Vec<u8>
§final_byte: u8
§

Osc(String)

ESC ] ...: an OSC string, terminated by BEL or ST (ESC \). Payload bytes are decoded as UTF-8 (lossily).

§

Other

A DCS/SOS/PM/APC string (intro is P, X, ^, or _), swallowed whole and surfaced raw rather than interpreted.

Fields

§intro: u8
§data: Vec<u8>

Trait Implementations§

Source§

impl Clone for Token

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Token

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for Token

Source§

impl PartialEq for Token

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for Token

Auto Trait Implementations§

§

impl Freeze for Token

§

impl RefUnwindSafe for Token

§

impl Send for Token

§

impl Sync for Token

§

impl Unpin for Token

§

impl UnsafeUnpin for Token

§

impl UnwindSafe for Token

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.