Struct rat_salsa::RunConfig

pub struct RunConfig<App, Global, Action, Error>
where
    App: AppWidget<Global, Action, Error>,
    Action: 'static + Send + Debug,
    Error: 'static + Send + Debug,
{
    pub n_threats: usize,
    pub term: Box<dyn Terminal<App, Global, Action, Error>>,
    pub poll: Vec<Box<dyn PollEvents<App, Global, Action, Error>>>,
}

Captures some parameters for crate::run_tui().

Fields

n_threats: usize

How many worker threads are wanted? Most of the time 1 should be sufficient to offload any gui-blocking tasks.

term: Box<dyn Terminal<App, Global, Action, Error>>

This is the renderer that connects to the backend, and calls out for rendering the application.

Defaults to RenderCrossterm.

poll: Vec<Box<dyn PollEvents<App, Global, Action, Error>>>

List of all event-handlers for the application.

Defaults to PollTimers, PollCrossterm, PollTasks. Add yours here.

Implementations

impl<App, Global, Action, Error> RunConfig<App, Global, Action, Error>

where App: AppWidget<Global, Action, Error>, Action: 'static + Send + Debug, Error: 'static + Send + Debug + From<Error> + From<TryRecvError>,

pub fn default() -> Result<Self, Error>

New configuration with some defaults.

pub fn threads(self, n: usize) -> Self

Number of threads.

pub fn term( self, term: impl Terminal<App, Global, Action, Error> + 'static, ) -> Self

Terminal is a rat-salsa::terminal::Terminal not a ratatui::Terminal.

pub fn no_poll(self) -> Self

Remove default PollEvents.

pub fn poll( self, poll: impl PollEvents<App, Global, Action, Error> + 'static, ) -> Self

Add poll

Trait Implementations

impl<App, Global, Action, Error> Debug for RunConfig<App, Global, Action, Error>

where App: AppWidget<Global, Action, Error>, Action: 'static + Send + Debug, Error: 'static + Send + Debug,

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.