Skip to main content

PluginRuntime

Struct PluginRuntime 

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

Preconfigured Wasmtime runtime environment for loading plugins.

The engine is shared across instances; the linker is configured once with the WASIp1 imports and Martensite host functions.

§Examples

use martensite_plugin::{CapabilitySet, PluginRuntime};

let runtime = PluginRuntime::new().unwrap();
// The empty capability set gives the plugin no host access.
let _ = runtime.load(b"\0asm\x01\0\0\0", CapabilitySet::empty());
// (Loading a real wasm module would succeed; a minimal header is shown here.)

Implementations§

Source§

impl PluginRuntime

Source

pub fn new() -> Result<Self, PluginError>

Creates a new runtime with the default fuel budget.

§Errors

Returns an error if the Wasmtime engine cannot be initialized.

§Examples
use martensite_plugin::PluginRuntime;

let runtime = PluginRuntime::new().unwrap();
Source

pub fn with_fuel_budget(fuel_budget: u64) -> Result<Self, PluginError>

Creates a new runtime with a custom fuel budget.

§Errors

Returns an error if the Wasmtime engine cannot be initialized.

§Examples
use martensite_plugin::PluginRuntime;

let runtime = PluginRuntime::with_fuel_budget(50_000).unwrap();
Source

pub fn engine(&self) -> &Engine

Returns the Wasmtime engine used by this runtime.

Epoch interruption is configured for every plugin store. The host must call Engine::increment_epoch on this engine on a 5 ms cadence to enforce the wall-clock deadline in addition to the fuel budget.

§Examples
use martensite_plugin::PluginRuntime;

let runtime = PluginRuntime::new().unwrap();
let _engine = runtime.engine();
Source

pub fn load( &self, wasm_bytes: &[u8], caps: CapabilitySet, ) -> Result<PluginInstance, PluginError>

Loads and instantiates a plugin with the given capability set.

The returned PluginInstance is independent from the runtime and can be invoked repeatedly until its fuel budget is exhausted.

§Errors

Returns an error if compilation, instantiation, or fuel setup fails.

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

let runtime = PluginRuntime::new().unwrap();
// Loading invalid bytes returns an error.
assert!(runtime.load(b"not wasm", CapabilitySet::empty()).is_err());

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> GetSetFdFlags for T

Source§

fn get_fd_flags(&self) -> Result<FdFlags, Error>
where T: AsFilelike,

Query the “status” flags for the self file descriptor.
Source§

fn new_set_fd_flags(&self, fd_flags: FdFlags) -> Result<SetFdFlags<T>, Error>
where T: AsFilelike,

Create a new SetFdFlags value for use with set_fd_flags. Read more
Source§

fn set_fd_flags(&mut self, set_fd_flags: SetFdFlags<T>) -> Result<(), Error>
where T: Sized + AsFilelike,

Set the “status” flags for the self file descriptor. Read more
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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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