Struct extism::Plugin

pub struct Plugin {
    pub id: Uuid,
    /* private fields */
}

Plugin contains everything needed to execute a WASM function

Fields

id: Uuid

A unique ID for each plugin

Implementations

impl Plugin

pub fn new<'a>( wasm: impl Into<WasmInput<'a>>, imports: impl IntoIterator<Item = Function>, with_wasi: bool ) -> Result<Plugin, Error>

Create a new plugin from a Manifest or WebAssembly module, and host functions. The with_wasi parameter determines whether or not the module should be executed with WASI enabled.

pub fn function_exists(&mut self, function: impl AsRef<str>) -> bool

Returns true if the given function exists, otherwise false

pub fn reset(&mut self) -> Result<(), Error>

Reset Extism runtime, this will invalidate all allocated memory

pub fn has_wasi(&self) -> bool

Determine if wasi is enabled

pub fn call<'a, 'b, T: ToBytes<'a>, U: FromBytes<'b>>( &'b mut self, name: impl AsRef<str>, input: T ) -> Result<U, Error>

Call a function by name with the given input, the return value is the output data returned by the plugin. The return type can be anything that implements FromBytes. This data will be invalidated next time the plugin is called.

Arguments

• name - A string representing the name of the export function to call
• input - The input argument to the function. Type should implment ToBytes.

Examples

// call takes a ToBytes and FromBytes type
// this function takes an &str and returns an &str
let output = plugin.call::<&str, &str>("greet", "Benjamin")?;
assert_eq!(output, "Hello, Benjamin!");

pub fn call_get_error_code<'a, 'b, T: ToBytes<'a>, U: FromBytes<'b>>( &'b mut self, name: impl AsRef<str>, input: T ) -> Result<U, (Error, i32)>

Similar to Plugin::call, but returns the Extism error code along with the Error. It is assumed if Ok(_) is returned that the error code was 0.

All Extism plugin calls return an error code, Plugin::call consumes the error code, while Plugin::call_get_error_code preserves it - this function should only be used when you need to inspect the actual return value of a plugin function when it fails.

pub fn cancel_handle(&self) -> CancelHandle

Get a CancelHandle, which can be used from another thread to cancel a running plugin

Trait Implementations

impl Debug for Plugin

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Send for Plugin

impl Sync for Plugin