Struct rat_salsa::AppContext

pub struct AppContext<'a, Global, Action, Error>
where
    Action: 'static + Send + Debug,
    Error: 'static + Send + Debug,
{
    pub g: &'a mut Global,
    pub timeout: Option<TimeOut>,
    /* private fields */
}

A collection of context data used by the application.

Fields

g: &'a mut Global

Some global state for the application.

timeout: Option<TimeOut>

Current timeout, if any.

Implementations

impl<'a, Global, Action, Error> AppContext<'a, Global, Action, Error>

where Action: 'static + Send + Debug, Error: 'static + Send + Debug,

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

Add a timer.

pub fn remove_timer(&self, tag: TimerHandle)

Remove a timer.

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

where Action: 'static + Send + Debug, Error: 'static + Send + Debug,

Add a background worker task.

let cancel = ctx.spawn(|cancel, send| {
    // ... do stuff
    Ok(Control::Continue)
});

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

Queue additional results.

X

pub fn queue_result(&self, ctrl: Result<Control<Action>, Error>)

Queue additional results.

Trait Implementations

impl<'a, Global: Debug, Action, Error> Debug for AppContext<'a, Global, Action, Error>

where Action: 'static + Send + Debug + Debug, Error: 'static + Send + Debug + Debug,

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

Formats the value using the given formatter.