Struct NativeSimulationHandle 

pub struct NativeSimulationHandle { /* private fields */ }

Low-level handle wrapping a celox::Simulation.

Implementations

impl NativeSimulationHandle

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

Create a new timed simulation from Veryl source code.

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

Create a timed simulation from a versioned external-frontend artifact.

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

Create a new timed simulation from a Veryl project directory.

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 default_max_steps(&self) -> Option<u32>

Returns the default maxSteps from [simulation] max_steps in celox.toml, or null if not configured.

pub fn add_clock( &mut self, event_id: u32, period: f64, initial_delay: f64, ) -> Result<()>

Register a clock by event ID.

pub fn schedule(&mut self, event_id: u32, time: f64, value: f64) -> Result<()>

Schedule a one-shot event by event ID.

pub fn run_until(&mut self, end_time: f64) -> Result<()>

Advance simulation until end_time.

pub fn step(&mut self) -> Result<Option<f64>>

Advance to the next event. Returns the new time, or null if no events.

pub fn time(&self) -> Result<f64>

Returns the current simulation time.

pub fn next_event_time(&self) -> Result<Option<f64>>

Returns the time of the next scheduled event, or null if none.

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 simulation’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.

Trait Implementations

impl FromNapiMutRef for NativeSimulationHandle

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 NativeSimulationHandle

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 NativeSimulationHandle

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 NativeSimulationHandle

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

impl ToNapiValue for NativeSimulationHandle

unsafe fn to_napi_value( env: napi_env, val: NativeSimulationHandle, ) -> 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 NativeSimulationHandle

fn type_name() -> &'static str

fn value_type() -> ValueType

impl TypeName for &NativeSimulationHandle

fn type_name() -> &'static str

fn value_type() -> ValueType

impl TypeName for &mut NativeSimulationHandle

fn type_name() -> &'static str

fn value_type() -> ValueType

impl TypeTag for NativeSimulationHandle

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 &NativeSimulationHandle

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 NativeSimulationHandle

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.