Skip to main content

ModuleContext

Struct ModuleContext 

Source
pub struct ModuleContext<'a> {
    pub schemas: &'a TypeSchemaRegistry,
    pub invoke_callable: Option<&'a dyn Fn(&ValueWord, &[ValueWord]) -> Result<ValueWord, String>>,
    pub raw_invoker: Option<RawCallableInvoker>,
    pub function_hashes: Option<&'a [Option<[u8; 32]>]>,
    pub vm_state: Option<&'a dyn VmStateAccessor>,
    pub granted_permissions: Option<PermissionSet>,
    pub scope_constraints: Option<ScopeConstraints>,
    pub set_pending_resume: Option<&'a dyn Fn(ValueWord)>,
    pub set_pending_frame_resume: Option<&'a dyn Fn(usize, Vec<ValueWord>)>,
}
Expand description

Execution context available to module functions during a VM call.

The VM constructs this before each module function dispatch and passes it by reference.

Fields§

§schemas: &'a TypeSchemaRegistry

Type schema registry — lookup types by name or ID.

§invoke_callable: Option<&'a dyn Fn(&ValueWord, &[ValueWord]) -> Result<ValueWord, String>>

Invoke a Shape callable (function/closure) from host code.

§raw_invoker: Option<RawCallableInvoker>

Raw invoker for extensions that need to capture a callable invoker beyond the borrow lifetime (e.g., CFFI callback userdata). Valid only for the duration of the current module function call.

§function_hashes: Option<&'a [Option<[u8; 32]>]>

Content-addressed function hashes indexed by function ID. Provided by the VM when content-addressed metadata is available. Uses raw [u8; 32] to avoid a dependency on shape-vm’s FunctionHash.

§vm_state: Option<&'a dyn VmStateAccessor>

Read-only access to VM state (call frames, locals, etc.). Provided by the VM when state introspection is needed.

§granted_permissions: Option<PermissionSet>

Permissions granted to the current execution context. When Some, module functions check this before performing I/O. When None, all operations are allowed (backwards compatible).

§scope_constraints: Option<ScopeConstraints>

Scope constraints for the current execution context. Narrows permissions to specific paths, hosts, etc.

§set_pending_resume: Option<&'a dyn Fn(ValueWord)>

Callback for state.resume() to request full VM state restoration. The module function stores the snapshot; the dispatch loop applies it after the current instruction completes.

§set_pending_frame_resume: Option<&'a dyn Fn(usize, Vec<ValueWord>)>

Callback for state.resume_frame() to request mid-function resume. Stores (ip_offset, locals) so the dispatch loop can override the call frame set up by invoke_callable.

Auto Trait Implementations§

§

impl<'a> Freeze for ModuleContext<'a>

§

impl<'a> !RefUnwindSafe for ModuleContext<'a>

§

impl<'a> !Send for ModuleContext<'a>

§

impl<'a> !Sync for ModuleContext<'a>

§

impl<'a> Unpin for ModuleContext<'a>

§

impl<'a> UnsafeUnpin for ModuleContext<'a>

§

impl<'a> !UnwindSafe for ModuleContext<'a>

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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
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<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