Struct TerminalEventBuffer

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

Cloneable single-threaded FIFO event source.

Clones share the same Rc<RefCell<_>> queue. Reentrant mutable access panics according to RefCell rules; the type is not thread-safe.

§Examples

use ailloli_ui_widgets::controls::{TerminalEvent, TerminalEventBuffer, TerminalEventSource};
let writer = TerminalEventBuffer::new();
let reader = writer.clone();
writer.push(TerminalEvent::clear(1));
assert_eq!(reader.drain_events().len(), 1);

Implementations§

Source§

impl TerminalEventBuffer

Source

pub fn new() -> Self

Creates an empty shared queue.

§Examples
use ailloli_ui_widgets::controls::TerminalEventBuffer;
assert!(TerminalEventBuffer::new().is_empty());
Source

pub fn push(&self, event: TerminalEvent)

Appends one event to the FIFO tail.

§Panics

Panics if the shared queue is already mutably borrowed reentrantly.

§Examples
use ailloli_ui_widgets::controls::{TerminalEvent, TerminalEventBuffer};
let buffer = TerminalEventBuffer::new();
buffer.push(TerminalEvent::clear(1));
assert!(!buffer.is_empty());
Source

pub fn extend(&self, events: impl IntoIterator<Item = TerminalEvent>)

Appends events to the FIFO tail in iterator order.

§Panics

Panics if the shared queue is already mutably borrowed reentrantly.

§Examples
use ailloli_ui_widgets::controls::{TerminalEvent, TerminalEventBuffer, TerminalEventSource};
let buffer = TerminalEventBuffer::new();
buffer.extend([TerminalEvent::clear(1), TerminalEvent::clear(2)]);
assert_eq!(buffer.drain_events().len(), 2);
Source

pub fn is_empty(&self) -> bool

Reports whether the shared queue currently has no pending event.

§Panics

Panics if the shared queue is already mutably borrowed.

§Examples
use ailloli_ui_widgets::controls::TerminalEventBuffer;
assert!(TerminalEventBuffer::new().is_empty());

Trait Implementations§

Source§

impl Clone for TerminalEventBuffer

Source§

fn clone(&self) -> TerminalEventBuffer

Returns a copy of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Default for TerminalEventBuffer

Source§

fn default() -> TerminalEventBuffer

Returns the “default value” for a type. Read more
Source§

impl TerminalEventSource for TerminalEventBuffer

Source§

fn drain_events(&self) -> Vec<TerminalEvent>

Drains every queued event in FIFO order.

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.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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.

§

impl<A> IntoClickAction<A> for A
where A: Clone + 'static,

§

fn into_click_action(self) -> ClickAction<A>

Implements the into_click_action helper used by this module.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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.
§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

impl<T> ErasedDestructor for T
where T: 'static,

§

impl<T> Props for T
where T: Clone + 'static,