tuirealm::listener

Struct EventListenerCfg

source 
pub struct EventListenerCfg<U>
where
    U: Eq + PartialEq + Clone + PartialOrd + Send,
{ /* private fields */ }
Expand description

The event listener configurator is used to setup an event listener. Once you’re done with configuration just call EventListenerCfg::start and the event listener will start and the listener will be returned.

Implementations§

source§

impl<U> EventListenerCfg<U>
where U: Eq + PartialEq + Clone + PartialOrd + Send + 'static,

source

pub fn poll_timeout(self, timeout: Duration) -> Self

Set poll timeout. Poll timeout is the maximum time to wait when fetching the thread receiver.

Panics if timeout is 0

source

pub fn tick_interval(self, interval: Duration) -> Self

Defines the tick interval for the event listener. If an interval is defined, this will also enable the Tick event.

source

pub fn add_port( self, poll: Box<dyn Poll<U>>, interval: Duration, max_poll: usize, ) -> Self

Add a new Port (Poll, Interval) to the the event listener.

The interval is the amount of time between each Poll::poll call. The max_poll is the maximum amount of times the port should be polled in a single poll.

source

pub fn port(self, port: Port<U>) -> Self

Add a new Port to the the event listener

The Port needs to be manually constructed, unlike Self::add_port

source

pub fn crossterm_input_listener( self, interval: Duration, max_poll: usize, ) -> Self

Add to the event listener the default crossterm input listener crate::terminal::CrosstermInputListener

The interval is the amount of time between each Poll::poll call. The max_poll is the maximum amount of times the port should be polled in a single poll.

source

pub fn termion_input_listener(self, interval: Duration, max_poll: usize) -> Self

Add to the event listener the default termion input listener crate::terminal::TermionInputListener

The interval is the amount of time between each Poll::poll call. The max_poll is the maximum amount of times the port should be polled in a single poll.

Trait Implementations§

source§

impl<U> Default for EventListenerCfg<U>
where U: Eq + PartialEq + Clone + PartialOrd + Send,

source§

fn default() -> Self

Returns the “default value” for a type. 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, 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> IntoEither for T

source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. 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.