Struct PluginManifest 

pub struct PluginManifest {
    pub wasm: Vec<Wasm>,
    pub memory: MemoryOptions,
    pub config: BTreeMap<String, String>,
    pub allowed_hosts: Option<Vec<String>>,
    pub allowed_paths: Option<BTreeMap<String, PathBuf>>,
    pub timeout_ms: Option<u64>,
}

The Manifest type is used to configure the runtime and specify how to load modules.

Fields

wasm: Vec<Wasm>

WebAssembly modules, the main module should be named main or listed last

memory: MemoryOptions

Memory options

config: BTreeMap<String, String>

Config values are made accessible using the PDK extism_config_get function

allowed_hosts: Option<Vec<String>>

Specifies which hosts may be accessed via HTTP, if this is empty then no hosts may be accessed. Wildcards may be used.

allowed_paths: Option<BTreeMap<String, PathBuf>>

Specifies which paths should be made available on disk when using WASI. This is a mapping from the path on disk to the path it should be available inside the plugin. For example, ".": "/tmp" would mount the current directory as /tmp inside the module

timeout_ms: Option<u64>

The plugin timeout in milliseconds

Implementations

impl Manifest

pub fn new(wasm: impl IntoIterator<Item = impl Into<Wasm>>) -> Manifest

Create a new manifest

pub fn with_wasm(self, wasm: impl Into<Wasm>) -> Manifest

pub fn disallow_all_hosts(self) -> Manifest

Disallow HTTP requests to all hosts

pub fn with_memory_options(self, memory: MemoryOptions) -> Manifest

Set memory options

pub fn with_memory_max(self, max: u32) -> Manifest

Set MemoryOptions::memory_max

pub fn with_allowed_host(self, host: impl Into<String>) -> Manifest

Add a hostname to allowed_hosts

pub fn with_allowed_hosts(self, hosts: impl Iterator<Item = String>) -> Manifest

Set allowed_hosts

pub fn with_allowed_path(self, src: String, dest: impl AsRef<Path>) -> Manifest

Add a path to allowed_paths

pub fn with_allowed_paths( self, paths: impl Iterator<Item = (String, PathBuf)>, ) -> Manifest

Set allowed_paths

pub fn with_config( self, c: impl Iterator<Item = (impl Into<String>, impl Into<String>)>, ) -> Manifest

Set config

pub fn with_config_key( self, k: impl Into<String>, v: impl Into<String>, ) -> Manifest

Set a single config key

pub fn with_timeout(self, timeout: Duration) -> Manifest

Set timeout_ms, which will interrupt a plugin function’s execution if it meets or exceeds this value. When an interrupt is made, the plugin will not be able to recover and continue execution.

Trait Implementations

impl Clone for Manifest

fn clone(&self) -> Manifest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Manifest

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

Formats the value using the given formatter.

impl Default for Manifest

fn default() -> Manifest

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Manifest

fn deserialize<__D>( __deserializer: __D, ) -> Result<Manifest, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Manifest

fn eq(&self, other: &Manifest) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Manifest

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Manifest