Struct proto::PluginContainer

pub struct PluginContainer<'plugin> {
    pub id: Id,
    pub manifest: Manifest,
    /* private fields */
}

A container around Extism’s [Plugin] and [Manifest] types that provides convenience methods for calling and caching functions from the WASM plugin. It also provides additional methods for easily working with WASI and virtual paths.

Fields

id: Id

manifest: Manifest

Implementations

impl<'plugin> PluginContainer<'plugin>

pub fn new<'new>( id: Id, manifest: Manifest, functions: impl IntoIterator<Item = Function> ) -> Result<PluginContainer<'new>, Report>

Create a new container with the provided manifest and host functions.

pub fn new_without_functions<'new>( id: Id, manifest: Manifest ) -> Result<PluginContainer<'new>, Report>

Create a new container with the provided manifest.

pub fn cache_func<O>(&self, func: &str) -> Result<O, Report>where O: Debug + DeserializeOwned,

Call a function on the plugin with no input and cache the output before returning it. Subsequent calls will read from the cache.

pub fn cache_func_with<I, O>(&self, func: &str, input: I) -> Result<O, Report>where I: Debug + Serialize, O: Debug + DeserializeOwned,

Call a function on the plugin with the given input and cache the output before returning it. Subsequent calls with the same input will read from the cache.

pub fn call_func<O>(&self, func: &str) -> Result<O, Report>where O: Debug + DeserializeOwned,

Call a function on the plugin with no input and return the output.

pub fn call_func_with<I, O>(&self, func: &str, input: I) -> Result<O, Report>where I: Debug + Serialize, O: Debug + DeserializeOwned,

Call a function on the plugin with the given input and return the output.

pub fn call_func_without_output<I>( &self, func: &str, input: I ) -> Result<(), Report>where I: Debug + Serialize,

Call a function on the plugin with the given input and ignore the output.

pub fn has_func(&self, func: &str) -> bool

Return true if the plugin has a function with the given id.

pub fn from_virtual_path(&self, path: &Path) -> PathBuf

Convert the provided virtual guest path to an absolute host path.

pub fn to_virtual_path(&self, path: &Path) -> PathBuf

Convert the provided absolute host path to a virtual guest path suitable for WASI sandboxed runtimes.

pub fn call(&self, func: &str, input: impl AsRef<[u8]>) -> Result<&[u8], Report>

Call a function on the plugin with the given raw input and return the raw output.

Trait Implementations

impl<'plugin> Send for PluginContainer<'plugin>

impl<'plugin> Sync for PluginContainer<'plugin>