Struct SalsaAppContext 

pub struct SalsaAppContext<Event, Error>
where
    Event: 'static,
    Error: 'static,
{ /* private fields */ }

Application context for event handling.

Add this to your global state and implement SalsaContext to access the facilities of rat-salsa. You can Default::default() initialize this field with some dummy values. It will be set correctly when calling run_tui.

Trait Implementations

impl<Event, Error> Debug for SalsaAppContext<Event, Error>

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

Formats the value using the given formatter.

impl<Event, Error> Default for SalsaAppContext<Event, Error>

where Event: 'static, Error: 'static,

fn default() -> Self

Returns the “default value” for a type.

impl<Event, Error> SalsaContext<Event, Error> for SalsaAppContext<Event, Error>

where Event: 'static, Error: 'static,

fn set_salsa_ctx(&mut self, app_ctx: SalsaAppContext<Event, Error>)

The AppContext struct holds all the data for the rat-salsa functionality. run_tui calls this to set the initialized struct.

fn salsa_ctx(&self) -> &SalsaAppContext<Event, Error>

Access the AppContext previously set.

fn count(&self) -> usize

Get the current frame/render-count.

fn last_render(&self) -> Duration

Get the last render timing.

fn last_event(&self) -> Duration

Get the last event-handling timing.

fn set_screen_cursor(&self, cursor: Option<(u16, u16)>)

Set the cursor, if the given value is something, hides it otherwise.

fn add_timer(&self, t: TimerDef) -> TimerHandle

Add a timer.

fn remove_timer(&self, tag: TimerHandle)

Remove a timer.

fn replace_timer(&self, h: Option<TimerHandle>, t: TimerDef) -> TimerHandle

Replace a timer. Remove the old timer and create a new one. If the old timer no longer exists it just creates the new one.

fn spawn_ext( &self, task: impl FnOnce(Cancel, &Sender<Result<Control<Event>, Error>>) -> Result<Control<Event>, Error> + Send + 'static, ) -> Result<(Cancel, Liveness), SendError<()>>

where Event: 'static + Send, Error: 'static + Send,

Add a background worker task.

fn spawn( &self, task: impl FnOnce() -> Result<Control<Event>, Error> + Send + 'static, ) -> Result<(), SendError<()>>

where Event: 'static + Send, Error: 'static + Send,

Add a background worker task.

fn queue_event(&self, event: Event)

Queue an application event.

fn queue(&self, ctrl: impl Into<Control<Event>>)

Queue additional results.

fn queue_err(&self, err: Error)

Queue an error.

fn set_focus(&self, focus: Focus)

Set the Focus.

fn take_focus(&self) -> Option<Focus>

Take the Focus back from the Context.

fn clear_focus(&self)

Clear the Focus.

fn focus<'a>(&'a self) -> Ref<'a, Focus>

Access the Focus.

fn focus_mut<'a>(&'a mut self) -> RefMut<'a, Focus>

Mutably access the focus-field.

fn handle_focus<E>(&mut self, event: &E) -> Outcome

where Focus: HandleEvent<E, Regular, Outcome>,

Handle the focus-event and automatically queue the result.

fn terminal(&mut self) -> Rc<RefCell<dyn Terminal<Error>>>

Access the terminal.

fn clear_terminal(&mut self)

Clear the terminal and do a full redraw before the next draw.

fn insert_before( &mut self, height: u16, draw_fn: impl FnOnce(&mut Buffer) + 'static, )

Call insert_before() before the next draw.