Skip to main content

HostFunctions

Struct HostFunctions 

Source
pub struct HostFunctions(/* private fields */);
Expand description

A collection of host functions that can be supplied to a sandbox constructor (e.g. MultiUseSandbox::from_snapshot). A collection of host functions that can be supplied to a sandbox constructor (e.g. crate::MultiUseSandbox::from_snapshot) to expose host-side functionality to the guest.

Use HostFunctions::default to start with the standard HostPrint function pre-registered (matches the registry that the regular UninitializedSandboxevolve() path constructs), or HostFunctions::empty to start with an empty registry.

Add additional host functions via the crate::func::Registerable trait, just as you would on an UninitializedSandbox.

// Default: HostPrint already registered.
let mut funcs = HostFunctions::default();
funcs.register_host_function("Add", |a: i32, b: i32| Ok(a + b))?;

Implementations§

Source§

impl HostFunctions

Source

pub fn empty() -> Self

Create an empty HostFunctions with no host functions registered.

Most callers want HostFunctions::default instead, which pre-registers the standard HostPrint function. An empty registry will fail snapshot validation against any snapshot that captured HostPrint, and any guest code that tries to printf into an empty registry will get an EIO from write(2).

Trait Implementations§

Source§

impl Default for HostFunctions

Source§

fn default() -> Self

Create a HostFunctions pre-populated with the standard HostPrint function (writes UTF-8 strings to the host’s stdout in green).

This matches the default registry installed by UninitializedSandbox::new(), so a snapshot taken from a regular sandbox can be loaded with MultiUseSandbox::from_snapshot(snap, HostFunctions::default(), None) without registering anything else.

Use HostFunctions::empty for an empty registry.

Source§

impl Registerable for HostFunctions

Source§

fn register_host_function<Args: ParameterTuple, Output: SupportedReturnType>( &mut self, name: &str, hf: impl Into<HostFunction<Output, Args>>, ) -> Result<()>

Register a primitive host function

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> 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> 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 = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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