Struct Cx 

pub struct Cx<'a> { /* private fields */ }

The call a PluginFn body receives: its arguments, the sink it emits commands into, and the host it can reach.

Mirrors lumen_script::ScriptFnCx, which is what a body would receive if the same function were registered in-process.

Implementations

impl<'a> Cx<'a>

pub fn new( args: &'a [ScriptValue], out: &'a mut Vec<ScriptCommand>, host: Host, ) -> Self

Wrap the arguments of one call, the scratch its commands land in, and the host it may call back into.

pub fn args(&self) -> &[ScriptValue]

Every argument the script passed.

pub fn arg(&self, i: usize) -> ScriptValue

Argument i, or ScriptValue::Unit when the call passed fewer.

pub fn arg_ref(&self, i: usize) -> &ScriptValue

Argument i by reference, for a body that only reads it.

pub fn str_arg(&self, i: usize) -> String

Argument i as a string. Non-strings take their canonical rendering; a missing argument is the empty string.

pub fn int_arg(&self, i: usize) -> i64

Argument i as an integer. Floats truncate, numeric strings parse, and anything else (including a missing argument) is 0.

pub fn float_arg(&self, i: usize) -> f64

Argument i as a float. Integers widen, numeric strings parse, and anything else (including a missing argument) is 0.0.

pub fn bool_arg(&self, i: usize) -> bool

Argument i as a boolean. 0 and "" are false, other numbers and non-empty strings other than "false" are true, and a missing argument is false.

pub fn emit(&mut self, cmd: ScriptCommand)

Queue a command. The engine applies it on the tick the call happened, even when the call goes on to fail.

pub fn host(&self) -> &Host

The host, for the effects that outlive the call.