Skip to main content

Event

Enum Event 

Source
pub enum Event<'a> {
    Text(&'a [u8]),
    Control(u8),
    Csi {
        private: Option<u8>,
        params: &'a [u16],
        intermediates: &'a [u8],
        final_byte: u8,
    },
    Esc {
        intermediates: &'a [u8],
        final_byte: u8,
    },
    Osc(&'a [u8]),
    Other {
        intro: u8,
        data: &'a [u8],
    },
}
Expand description

One parsed unit, borrowed: nothing here is owned or copied.

The lifetime is per call, not per feed_with: Event::Text borrows the bytes passed in, while sequence payloads borrow the parser’s scratch buffers, which the next sequence reuses. Keep what you need before returning.

Variants§

§

Text(&'a [u8])

A run of printable bytes, exactly as they arrived: not validated as UTF-8, and a multi-byte character split across two feed_with calls arrives as the tail of one run and the head of the next. Callers that need str decode it themselves; Parser::feed does that and replaces invalid bytes with U+FFFD.

§

Control(u8)

A C0 control byte executed on its own, or DEL.

§

Csi

A CSI sequence. params and intermediates borrow parser scratch.

Fields

§private: Option<u8>
§params: &'a [u16]
§intermediates: &'a [u8]
§final_byte: u8
§

Esc

A non-CSI escape sequence.

Fields

§intermediates: &'a [u8]
§final_byte: u8
§

Osc(&'a [u8])

An OSC string’s payload, without the introducer or terminator.

§

Other

A DCS/SOS/PM/APC string’s payload.

Fields

§intro: u8
§data: &'a [u8]

Trait Implementations§

Source§

impl<'a> Clone for Event<'a>

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<'a> Copy for Event<'a>

Source§

impl<'a> Debug for Event<'a>

Source§

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

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

impl<'a> Eq for Event<'a>

Source§

impl<'a> PartialEq for Event<'a>

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<'a> StructuralPartialEq for Event<'a>

Auto Trait Implementations§

§

impl<'a> Freeze for Event<'a>

§

impl<'a> RefUnwindSafe for Event<'a>

§

impl<'a> Send for Event<'a>

§

impl<'a> Sync for Event<'a>

§

impl<'a> Unpin for Event<'a>

§

impl<'a> UnsafeUnpin for Event<'a>

§

impl<'a> UnwindSafe for Event<'a>

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.