Struct termimad::EventSource [−][src]
pub struct EventSource { /* fields omitted */ }
Expand description
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]
impl EventSource
[src]pub fn new() -> Result<EventSource, Error>
[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]
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]
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 escape_sequence_receiver(&self) -> Receiver<EscapeSequence>
[src]
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
Auto Trait Implementations
impl RefUnwindSafe for EventSource
impl Send for EventSource
impl Sync for EventSource
impl Unpin for EventSource
impl UnwindSafe for EventSource
Blanket Implementations
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]pub fn borrow_mut(&mut self) -> &mut T
[src]
pub fn borrow_mut(&mut self) -> &mut T
[src]Mutably borrows from an owned value. Read more
impl<T> Pointable for T
impl<T> Pointable for T