Skip to main content

HeadlessEventSource

Struct HeadlessEventSource 

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

A no-op event source for headless and test programs.

Returns a fixed terminal size, accepts feature changes silently, and never produces events. This allows the test helper to construct a Program without depending on crossterm or a real terminal.

Implementations§

Source§

impl HeadlessEventSource

Source

pub fn new(width: u16, height: u16, features: BackendFeatures) -> Self

Create a headless event source with the given terminal size.

Trait Implementations§

Source§

impl BackendEventSource for HeadlessEventSource

Source§

type Error = Error

Platform-specific error type.
Source§

fn size(&self) -> Result<(u16, u16), Error>

Query current terminal dimensions (columns, rows).
Source§

fn set_features(&mut self, features: BackendFeatures) -> Result<(), Error>

Enable or disable terminal features (mouse, paste, focus, kitty keyboard). Read more
Source§

fn poll_event(&mut self, _timeout: Duration) -> Result<bool, Error>

Poll for an available event, returning true if one is ready. Read more
Source§

fn read_event(&mut self) -> Result<Option<Event>, Error>

Read the next available event, or None if none is ready. Read more

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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

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

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

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.

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.
Source§

impl<T> WithSubscriber for T

Source§

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
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

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