Struct wasmedge_sdk::plugin::PluginDescriptor

pub struct PluginDescriptor { /* private fields */ }

Represents Plugin descriptor for plugins.

Implementations

impl PluginDescriptor

pub fn new( name: impl AsRef<str>, desc: impl AsRef<str>, version: PluginVersion ) -> WasmEdgeResult<Self>

Creates a new plugin descriptor.

Arguments

• name - The name of the plugin.

• desc - The description of the plugin.

• version - The version of the plugin.

Error

If fail to create the plugin descriptor, then an error will be returned.

pub fn add_module_descriptor( self, name: impl AsRef<str>, desc: impl AsRef<str>, f: Option<ModuleInstanceCreateFn> ) -> WasmEdgeResult<Self>

Adds a module descriptor to the plugin descriptor.

Arguments

• name - The name of the module.

• desc - The description of the module.

• f - The function that creates a module instance for the plugin.

Error

If fail to add the module descriptor, then an error will be returned.

pub fn add_program_option( self, name: impl AsRef<str>, desc: impl AsRef<str>, ty: ProgramOptionType ) -> WasmEdgeResult<Self>

Adds a program option to the plugin descriptor.

Arguments

• name - The name of the program option.

• desc - The description of the program option.

• ty - The type of the program option.

Error

If fail to add the program option, then an error will be returned.

pub fn as_raw_ptr(&self) -> *const WasmEdge_PluginDescriptor

Available on crate feature ffi only.

Returns the raw pointer to the inner WasmEdge_PluginDescriptor.

Trait Implementations

impl Debug for PluginDescriptor

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

Formats the value using the given formatter.