Skip to main content

OutputEvent

Struct OutputEvent 

Source
pub struct OutputEvent { /* private fields */ }
Expand description

A single pane-output event retained by an OutputRing.

Implementations§

Source§

impl OutputEvent

Source

pub fn from_shared( sequence: u64, bytes: Arc<[u8]>, passthroughs: Vec<TerminalPassthrough>, ) -> Self

Creates an output event from already shared bytes.

Source

pub const fn sequence(&self) -> u64

Returns this event’s monotonic per-ring sequence.

Source

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

Returns the raw bytes carried by this output event.

Source

pub fn byte_len(&self) -> usize

Returns the raw byte count without cloning the event payload.

Source

pub fn is_empty(&self) -> bool

Returns whether the event carries no raw bytes.

Source

pub fn passthroughs(&self) -> &[TerminalPassthrough]

Returns terminal passthrough events produced by this output event.

Source

pub fn into_bytes(self) -> Vec<u8>

Consumes this event and returns its raw bytes.

Source

pub fn into_parts(self) -> (Vec<u8>, Vec<TerminalPassthrough>)

Consumes this event and returns both raw bytes and terminal side effects.

Source

pub fn into_passthroughs(self) -> Vec<TerminalPassthrough>

Consumes this event and returns only terminal side effects.

Live render subscribers already derive visible state from the pane transcript, so cloning raw output bytes just to inspect passthroughs is unnecessary on that hot path.

Source

pub fn with_passthroughs(self, passthroughs: Vec<TerminalPassthrough>) -> Self

Returns a copy of this event carrying terminal passthrough side effects.

Trait Implementations§

Source§

impl Clone for OutputEvent

Source§

fn clone(&self) -> OutputEvent

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 OutputEvent

Source§

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

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

impl Eq for OutputEvent

Source§

impl PartialEq for OutputEvent

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl StructuralPartialEq for OutputEvent

Auto Trait Implementations§

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 = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.