Struct PluginFnBuilder 

pub struct PluginFnBuilder { /* private fields */ }

Builder for a PluginFn. Start it with PluginFn::new.

Implementations

impl PluginFnBuilder

pub fn param(self, name: impl Into<String>, ty: ScriptTy) -> Self

Append a required parameter. Call in argument order.

pub fn ret(self, ty: ScriptTy) -> Self

Set the return type. Defaults to ScriptTy::Any; a function whose result really is open declares ScriptTy::Dynamic.

pub fn doc(self, doc: impl Into<String>) -> Self

Set the one-line description editor tooling shows.

pub fn ns(self, ns: ScriptNs) -> Self

Choose the namespace. Defaults to ScriptNs::Extension. ScriptNs::Builtin is the runtime’s own surface and a host refuses a manifest that claims it.

pub fn min_arity(self, min_arity: usize) -> Self

Make the trailing parameters optional: a call may pass as few as min_arity arguments, and the body reads the rest as ScriptValue::Unit.

pub fn variadic(self) -> Self

Accept arguments past the declared parameters.

pub fn build<F>(self, body: F) -> PluginFn

where F: Fn(&mut Cx<'_>) -> Result<ScriptValue, String> + Send + Sync + 'static,

Finish with the body.

The body returns Ok(value), or Err(message) to raise message in the script that called it.