Struct PluginFn 

pub struct PluginFn { /* private fields */ }

One function a plugin offers to the app’s scripts.

Describes the same thing lumen_script::ScriptFn does in-process: a name, a namespace, a signature, and a body.

Implementations

impl PluginFn

pub fn new(name: impl Into<String>) -> PluginFnBuilder

Start a description. Finish it with PluginFnBuilder::build.

use lumen_plugin::{PluginFn, ScriptTy, ScriptValue};

let f = PluginFn::new("gpio_read")
    .param("pin", ScriptTy::Int)
    .ret(ScriptTy::Bool)
    .doc("Read a GPIO pin.")
    .build(|cx| Ok(ScriptValue::Bool(cx.int_arg(0) % 2 == 0)));

pub fn name(&self) -> &str

The name the script calls it by.