Skip to main content

PluginInstance

Struct PluginInstance 

Source
pub struct PluginInstance { /* private fields */ }
Expand description

A running WebAssembly plugin instance.

Holds the Wasmtime Store and Instance for a single plugin. All calls happen in the context of this instance and consume its fuel budget.

§Examples

use martensite_plugin::{CapabilitySet, PluginRuntime};

let wasm_bytes: &[u8] = b"";
let runtime = PluginRuntime::new().unwrap();
let mut plugin = runtime.load(wasm_bytes, CapabilitySet::empty()).unwrap();
plugin.invoke("run").unwrap();

Implementations§

Source§

impl PluginInstance

Source

pub fn invoke(&mut self, name: &str) -> Result<(), PluginError>

Invokes an exported function that takes no parameters and returns nothing.

§Errors

Returns PluginError::MissingExport if the export does not exist or has the wrong signature, or any other plugin error if execution fails.

§Examples
use martensite_plugin::{CapabilitySet, PluginRuntime};

let runtime = PluginRuntime::new().unwrap();
let mut plugin = runtime.load(wasm_bytes, CapabilitySet::empty()).unwrap();
plugin.invoke("run").unwrap();
Source

pub fn invoke_typed<Args, Rets>( &mut self, name: &str, args: Args, ) -> Result<Rets, PluginError>
where Args: WasmParams, Rets: WasmResults,

Invokes an exported function with a statically checked WebAssembly signature.

§Errors

Returns PluginError::MissingExport if the export does not exist or has a signature different from Args -> Rets, or any execution error produced by the plugin.

§Examples
use martensite_plugin::{CapabilitySet, PluginRuntime};

let wasm_bytes: &[u8] = b"";
let runtime = PluginRuntime::new().unwrap();
let mut plugin = runtime.load(wasm_bytes, CapabilitySet::empty()).unwrap();
let result: i32 = plugin.invoke_typed("add_one", 41).unwrap();
assert_eq!(result, 42);
Source

pub fn drain_paint_commands(&mut self, f: impl FnMut(&PluginPaintCmd, &[u8]))

Drains paint commands from this instance’s shared ring buffer.

The ring region lives inside guest-visible linear memory: either a host-grown region of the guest’s exported memory, or the dedicated martensite.ring_memory import. The guest produces commands by writing PluginPaintCmd records plus the head/tail cursor header directly; this call consumes and clears them. Does nothing when the plugin has no ring region.

§Examples
use martensite_plugin::{CapabilitySet, PluginRuntime};

let wasm_bytes: &[u8] = b"";
let runtime = PluginRuntime::new().unwrap();
let mut plugin = runtime.load(wasm_bytes, CapabilitySet::empty()).unwrap();
plugin.drain_paint_commands(|cmd, payload| {
    println!("cmd_type={}, {} bytes", cmd.cmd_type, payload.len());
});
Source

pub fn capabilities(&self) -> &CapabilitySet

Returns a reference to the capability set active for this instance.

§Examples
use martensite_plugin::{Capability, CapabilitySet, PluginRuntime};

let wasm_bytes: &[u8] = b"";
let caps = CapabilitySet::builder().grant(Capability::Network).build();
let runtime = PluginRuntime::new().unwrap();
let plugin = runtime.load(wasm_bytes, caps).unwrap();
assert!(plugin.capabilities().contains(&Capability::Network));

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Pointee for T

Source§

type Pointer = u32

Source§

fn debug( pointer: <T as Pointee>::Pointer, f: &mut Formatter<'_>, ) -> Result<(), Error>

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more