[go: up one dir, main page]

[−][src]Struct termimad::EventSource

pub struct EventSource { /* fields omitted */ }

a thread backed event listener emmiting events on a channel.

Additionnally to emmitting events, this source updates a sharable event count, protected by an Arc. This makes it easy for background computation to stop (or check if they should) when a user event is produced.

Implementations

impl EventSource[src]

pub fn new() -> Result<EventSource, Error>[src]

create a new source

If desired, mouse support must be enabled and disabled in crossterm.

pub fn unblock(&self, quit: bool)[src]

either start listening again, or quit, depending on the passed bool. It's mandatory to call this with quit=true at end for a proper ending of the thread (and its resources)

pub fn shared_event_count(&self) -> Arc<AtomicUsize>[src]

return a shared reference to the event count. Other threads can use it to check whether something happened (when there's no parallel computation, the event channel is usually enough).

pub fn receiver(&self) -> Receiver<Event>[src]

return a new receiver for the channel emmiting events

pub fn escape_sequence_receiver(&self) -> Receiver<EscapeSequence>[src]

return a new receiver for the channel emmiting escape sequences

It's a bounded channel and any escape sequence will be dropped when it's full

Trait Implementations

impl Drop for EventSource[src]

Auto Trait Implementations

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized, [src]

impl<T> Borrow<T> for T where
    T: ?Sized, [src]

impl<T> BorrowMut<T> for T where
    T: ?Sized, [src]

impl<T> From<T> for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, [src]

impl<T, U> TryFrom<U> for T where
    U: Into<T>, [src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, [src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.