Struct NativeSimulatorHandle 

pub struct NativeSimulatorHandle { /* private fields */ }

Low-level handle wrapping the default backend and optional VCD writer.

JS holds this as an opaque class; all operations go through methods.

Implementations

impl NativeSimulatorHandle

pub fn from_simulator( simulator: Simulator, vcd_path: Option<&str>, ) -> Result<Self>

Wrap a simulator built by an external frontend in the standard Celox N-API handle.

This is a Rust-only adapter API. A frontend binding can accept its own artifact type in a #[napi] function, lower it with celox-frontend-sdk, build a celox::Simulator, and pass the value here without serializing an artifact to JSON. Signal metadata is always derived from the simulator’s actual memory layout.

pub fn from_frontend( artifact: FrontendArtifact, options: Option<NapiOptions>, ) -> Result<Self>

Build an N-API handle directly from an in-memory frontend artifact.

Frontend bindings normally expose an artifact-specific function such as from_my_artifact and use this as their final adapter step.

impl NativeSimulatorHandle

pub fn new( sources: Vec<NapiSourceFile>, top: String, options: Option<NapiOptions>, ) -> Result<Self>

Create a new simulator from Veryl source code.

pub fn from_frontend_artifact( artifact_json: String, options: Option<NapiOptions>, ) -> Result<Self>

Create a simulator from a versioned external-frontend artifact.

pub fn from_project( project_path: String, top: String, options: Option<NapiOptions>, ) -> Result<Self>

Create a new simulator from a Veryl project directory.

Searches upward from project_path for Veryl.toml, gathers all .veryl source files, and builds the simulator using the project’s clock/reset settings.

pub fn layout_json(&self) -> String

Returns the signal layout as a JSON string.

pub fn events_json(&self) -> String

Returns the event map as a JSON string.

pub fn hierarchy_json(&self) -> String

Returns the instance hierarchy as a JSON string.

pub fn warnings_json(&self) -> String

Returns compilation warnings as a JSON array of strings.

pub fn stable_size(&self) -> u32

Returns the stable region size in bytes.

pub fn total_size(&self) -> u32

Returns the total memory size in bytes.

pub fn tick(&mut self, event_id: u32) -> Result<()>

Trigger a clock/event by its numeric ID.

pub fn tick_n(&mut self, event_id: u32, count: u32) -> Result<()>

Trigger a clock/event N times in a single NAPI call.

pub fn eval_comb(&mut self) -> Result<()>

Evaluate combinational logic.

pub fn dump(&mut self, timestamp: f64) -> Result<()>

Write VCD dump at the given timestamp.

pub fn shared_memory(&mut self) -> Result<Uint8Array>

Return the simulator’s stable memory region as a zero-copy Uint8Array. JS can access .buffer to get the underlying ArrayBuffer.

pub fn dispose(&mut self)

Invalidate this handle (no-op on the Rust side; drop happens via GC).

Trait Implementations

impl FromNapiMutRef for NativeSimulatorHandle

unsafe fn from_napi_mut_ref( env: napi_env, napi_val: napi_value, ) -> Result<&'static mut Self>

This function called to convert napi values to native rust values

impl FromNapiRef for NativeSimulatorHandle

unsafe fn from_napi_ref( env: napi_env, napi_val: napi_value, ) -> Result<&'static Self>

This function called to convert napi values to native rust values

impl JavaScriptClassExt for NativeSimulatorHandle

fn into_instance<'scope>( self, env: &'scope Env, ) -> Result<ClassInstance<'scope, Self>>

fn into_reference(self, env: Env) -> Result<Reference<Self>>

fn instance_of<'env, V: JsValue<'env>>(env: &Env, value: &V) -> Result<bool>

impl ObjectFinalize for NativeSimulatorHandle

fn finalize(self, env: Env) -> Result<(), Error>

impl ToNapiValue for NativeSimulatorHandle

unsafe fn to_napi_value( env: napi_env, val: NativeSimulatorHandle, ) -> Result<napi_value>

This function called to convert rust values to napi values

fn into_unknown(self, env: &Env) -> Result<Unknown<'_>, Error>

impl TypeName for NativeSimulatorHandle

fn type_name() -> &'static str

fn value_type() -> ValueType

impl TypeName for &NativeSimulatorHandle

fn type_name() -> &'static str

fn value_type() -> ValueType

impl TypeName for &mut NativeSimulatorHandle

fn type_name() -> &'static str

fn value_type() -> ValueType

impl TypeTag for NativeSimulatorHandle

fn type_tag() -> napi_type_tag

Returns this class’s stable per-type tag. The derive computes it from the class’s content identity string (crate@version::module_path::ClassName), which is fixed for a given class, so repeated calls return the same tag.

impl ValidateNapiValue for &NativeSimulatorHandle

unsafe fn validate(env: napi_env, napi_val: napi_value) -> Result<napi_value>

This function called to validate whether napi value passed to rust is valid type.

impl ValidateNapiValue for &mut NativeSimulatorHandle

unsafe fn validate(env: napi_env, napi_val: napi_value) -> Result<napi_value>

This function called to validate whether napi value passed to rust is valid type.