rat-salsa 4.0.3

ratatui widgets and a crossterm event-loop
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53

/// Trait for an event-source.
///
/// If you need to add your own do the following:
///
/// * Implement this trait for a struct that fits.
///
pub trait PollEvents<Event, Error>: std::any::Any
where
    Event: 'static,
    Error: 'static,
{
    fn as_any(&self) -> &dyn std::any::Any;

    /// Preferred sleep time for this event-source.
    fn sleep_time(&self) -> Option<Duration> {
        None
    }

    /// Poll for a new event.
    ///
    /// Events are not processed immediately when they occur. Instead,
    /// all event sources are polled, the poll state is put into a queue.
    /// Then the queue is emptied one by one and `read_execute()` is called.
    ///
    /// This prevents issues with poll-ordering of multiple sources, and
    /// one source cannot just flood the app with events.
    fn poll(&mut self) -> Result<bool, Error>;

    /// Read the event and distribute it.
    ///
    /// If you add a new event, that doesn't fit into AppEvents, you'll
    /// have to define a new trait for your AppState and use that.
    fn read(&mut self) -> Result<crate::Control<Event>, Error>;
}

mod crossterm;
mod quit;
mod rendered;
mod thread_pool;
mod tick;
mod timer;
#[cfg(feature = "async")]
mod tokio_tasks;

pub use crossterm::PollCrossterm;
pub use quit::PollQuit;
pub use rendered::PollRendered;
use std::time::Duration;
pub use thread_pool::PollTasks;
pub use tick::PollTick;
pub use timer::PollTimers;
#[cfg(feature = "async")]
pub use tokio_tasks::PollTokio;