Struct Backend 

pub struct Backend { /* private fields */ }

One plugin backend (see the module docs). Stops its process when dropped.

Implementations

impl Backend

pub fn new( plugin: &str, init: Value, events: &[String], prepare: Prepare, sink: Sink, ) -> Self

init is the init message (sent first to every process, with restart added); events the engine events it gets from the start.

pub fn plugin(&self) -> &str

pub fn wants(&self, event: &str) -> bool

It asked for engine event event.

pub fn status(&self) -> Status

pub fn start(&self)

Start it now if it isn’t running (normally it starts on first use).

pub fn event(&self, msg: Value) -> bool

Send an event message ({"type": "event", "event": …, …}), starting the backend if needed. false if it can’t take it (stopped, failed, too big).

pub fn request( &self, method: &str, params: Value, timeout: Duration, cancelled: &dyn Fn() -> bool, ) -> Result<Value, String>

Ask it something and wait for the reply (or timeout, or cancelled()).

pub fn report_fault(&self, text: &str)

A problem byob found in what it sent (e.g. a view tree it had to fix): kept in its status (faults) for the model and the user, and passed to the sink as a fault.

pub fn post(&self, msg: Value)

Hand msg to the sink as if the backend had sent it (the tool host uses this to pass a tool’s card on to the engine).

pub fn stop(&self, why: &str)

Stop the process for good (this object won’t start it again).

Trait Implementations

impl Drop for Backend

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.