Struct PluginBuilder 

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

PluginBuilder is used to configure and create Plugin instances

Implementations

impl<'a> PluginBuilder<'a>

pub fn new(plugin: impl Into<WasmInput<'a>>) -> Self

Create a new PluginBuilder from a Manifest or raw Wasm bytes

pub fn with_wasi(self, wasi: bool) -> Self

Enables WASI if the argument is set to true

pub fn with_function<T: 'static, F>( self, name: impl Into<String>, args: impl IntoIterator<Item = ValType>, returns: impl IntoIterator<Item = ValType>, user_data: UserData<T>, f: F, ) -> Self

where F: 'static + Fn(&mut CurrentPlugin, &[Val], &mut [Val], UserData<T>) -> Result<(), Error> + Sync + Send,

Add a single host function

pub fn with_function_in_namespace<T: 'static, F>( self, namespace: impl Into<String>, name: impl Into<String>, args: impl IntoIterator<Item = ValType>, returns: impl IntoIterator<Item = ValType>, user_data: UserData<T>, f: F, ) -> Self

where F: 'static + Fn(&mut CurrentPlugin, &[Val], &mut [Val], UserData<T>) -> Result<(), Error> + Sync + Send,

Add a single host function in a specific namespace

pub fn with_functions(self, f: impl IntoIterator<Item = Function>) -> Self

Add multiple host functions

pub fn with_profiling_strategy(self, p: ProfilingStrategy) -> Self

Set profiling strategy

pub fn with_coredump(self, path: impl Into<PathBuf>) -> Self

Enable Wasmtime coredump on trap

pub fn with_memdump(self, path: impl Into<PathBuf>) -> Self

Enable Extism memory dump when plugin calls return an error

pub fn with_debug_info(self) -> Self

Compile with debug info

pub fn with_debug_options(self, options: DebugOptions) -> Self

Configure debug options

pub fn with_cache_config(self, dir: impl Into<PathBuf>) -> Self

Set wasmtime compilation cache config path

pub fn with_cache_disabled(self) -> Self

Turn wasmtime compilation caching off

pub fn with_fuel_limit(self, fuel: u64) -> Self

Limit the number of instructions that can be executed

pub fn with_wasmtime_config(self, config: Config) -> Self

Configure an initial wasmtime config to be passed to the plugin

Warning: some values might be overwritten by the Extism runtime. In particular:

• async_support
• epoch_interruption
• debug_info
• coredump_on_trap
• profiler
• wasm_tail_call
• wasm_function_references
• wasm_gc

See the implementation details of PluginBuilder::build and [Plugin::build_new] to verify which values are overwritten.

pub fn with_http_response_headers(self, allow: bool) -> Self

Enables http_response_headers, which allows for plugins to access response headers when using extism:host/env::http_request

pub fn build(self) -> Result<Plugin, Error>

Generate a new plugin with the configured settings

pub fn compile(self) -> Result<CompiledPlugin, Error>

Build new CompiledPlugin

Trait Implementations

impl<'a> Clone for PluginBuilder<'a>

fn clone(&self) -> PluginBuilder<'a>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.