Struct Events 

pub struct Events { /* private fields */ }

Where a running Binding sends its events. Cheap to clone, and Send: the executor’s worker and plugins’ stderr readers hold one each.

Implementations

impl Events

pub fn new(sender: Sender<RunEvent>) -> Events

pub fn held(&self) -> Events

Events that are held until Events::flush, for one of several Bindings running at once.

pub fn emit(&self, e: RunEvent)

Send an event. Nobody listening (the run was abandoned) isn’t an error.

pub fn emit_now(&self, e: RunEvent)

Send an event now, even from held events.

pub fn flush(&self)

Send the held events as one block.

pub fn step( &self, level: Level, verb: &str, detail: &str, elapsed: Option<Duration>, )

pub fn warn(&self, msg: &str)

pub fn rows(&self, progress: RowProgress)

Progress is live even when the Binding’s other events are held for a block.

pub fn compiled(&self, plan: &BindingPlan)

pub fn message(&self, message: &ShownMessage)

pub fn binding_vars( &self, schedule: Option<&str>, schedule_vars: Option<&JsonMap<String, Json>>, vars: &JsonMap<String, Json>, )

pub fn plugin_log(&self) -> LogSink

Where plugin stderr goes: into the event stream.

pub fn sql_log(&self) -> LogSink

Where every statement’s full text goes: into the event stream.

Trait Implementations

impl Clone for Events

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.