Struct DefaultHost 

pub struct DefaultHost<D: DebugHandler = DefaultDebugHandler, S: SourceManager = DefaultSourceManager> { /* private fields */ }

A default Host implementation that provides the essential functionality required by the VM.

Implementations

impl<D, S> DefaultHost<D, S>

where D: DebugHandler, S: SourceManager,

pub fn with_source_manager<O>(self, source_manager: Arc<O>) -> DefaultHost<D, O>

where O: SourceManager,

Use the given source manager implementation instead of the default one DefaultSourceManager.

pub fn load_library( &mut self, library: impl Into<HostLibrary>, ) -> Result<(), ExecutionError>

Loads a HostLibrary containing a MastForest with its list of event handlers.

pub fn with_library( self, library: impl Into<HostLibrary>, ) -> Result<Self, ExecutionError>

Adds a HostLibrary containing a MastForest with its list of event handlers. to the host.

pub fn register_handler( &mut self, id: EventId, handler: Arc<dyn EventHandler>, ) -> Result<(), ExecutionError>

Registers a single EventHandler into this host.

The handler can be either a closure or a free function with signature fn(&mut ProcessState) -> Result<(), EventHandler>

pub fn unregister_handler(&mut self, id: EventId) -> bool

Un-registers a handler with the given id, returning a flag indicating whether a handler was previously registered with this id.

pub fn replace_handler( &mut self, id: EventId, handler: Arc<dyn EventHandler>, ) -> bool

Replaces a handler with the given id, returning a flag indicating whether a handler was previously registered with this id.

pub fn with_debug_handler<H: DebugHandler>( self, handler: H, ) -> DefaultHost<H, S>

Replace the current DebugHandler with a custom one.

Trait Implementations

impl<D, S> AsyncHost for DefaultHost<D, S>

where D: DebugHandler, S: SourceManagerSync,

fn get_mast_forest( &self, node_digest: &Word, ) -> impl FutureMaybeSend<Option<Arc<MastForest>>>

Returns MAST forest corresponding to the specified digest, or None if the MAST forest for this digest could not be found in this host.

fn on_event( &mut self, process: &ProcessState<'_>, ) -> impl FutureMaybeSend<Result<Vec<AdviceMutation>, EventError>>

Handles the event emitted from the VM and provides advice mutations to be applied to the advice provider.

impl<D, S> BaseHost for DefaultHost<D, S>

where D: DebugHandler, S: SourceManager,

fn on_assert_failed(&mut self, _process: &ProcessState<'_>, _err_code: Felt)

Handles the failure of the assertion instruction.

fn get_label_and_source_file( &self, location: &Location, ) -> (SourceSpan, Option<Arc<SourceFile>>)

Returns the SourceSpan and optional SourceFile for the provided location.

fn on_debug( &mut self, process: &mut ProcessState<'_>, options: &DebugOptions, ) -> Result<(), ExecutionError>

Handles the debug request from the VM.

fn on_trace( &mut self, process: &mut ProcessState<'_>, trace_id: u32, ) -> Result<(), ExecutionError>

Handles the trace emitted from the VM.

impl<D: Debug + DebugHandler, S: Debug + SourceManager> Debug for DefaultHost<D, S>

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

Formats the value using the given formatter.

impl Default for DefaultHost

fn default() -> Self

Returns the “default value” for a type.

impl<D, S> SyncHost for DefaultHost<D, S>

where D: DebugHandler, S: SourceManager,

fn get_mast_forest(&self, node_digest: &Word) -> Option<Arc<MastForest>>

Returns MAST forest corresponding to the specified digest, or None if the MAST forest for this digest could not be found in this host.

fn on_event( &mut self, process: &ProcessState<'_>, ) -> Result<Vec<AdviceMutation>, EventError>

Invoked when the VM encounters an EMIT operation.