Struct sim::simulator::web::WebSimulation

pub struct WebSimulation { /* fields omitted */ }

The WebSimulation provides JS/WASM-compatible interfaces to the core Simulation struct. For additional insight on these methods, refer to the associated Simulation methods. Errors are unwrapped, instead of returned, in the WebSimulation methods.

Implementations

impl WebSimulation

pub fn post_json(models: &str, connectors: &str) -> Self

A JS/WASM interface for Simulation.post, which uses JSON representations of the simulation models and connectors.

pub fn put_json(&mut self, models: &str, connectors: &str)

A JS/WASM interface for Simulation.put, which uses JSON representations of the simulation models and connectors.

pub fn get_json(&self) -> String

Get a JSON representation of the full Simulation configuration.

pub fn post_yaml(models: &str, connectors: &str) -> WebSimulation

A JS/WASM interface for Simulation.post, which uses YAML representations of the simulation models and connectors.

pub fn put_yaml(&mut self, models: &str, connectors: &str)

A JS/WASM interface for Simulation.put, which uses YAML representations of the simulation models and connectors.

pub fn get_yaml(&self) -> String

Get a YAML representation of the full Simulation configuration.

pub fn get_messages_js(&self) -> Array

A JS/WASM interface for Simulation.get_messages, which converts the messages to a JavaScript Array.

pub fn get_messages_json(&self) -> String

A JS/WASM interface for Simulation.get_messages, which converts the messages to a JSON string.

pub fn get_messages_yaml(&self) -> String

A JS/WASM interface for Simulation.get_messages, which converts the messages to a YAML string.

pub fn get_global_time(&self) -> f64

An interface to Simulation.get_global_time.

pub fn status(&self, model_id: &str) -> String

An interface to Simulation.status.

pub fn reset(&mut self)

An interface to Simulation.reset.

pub fn reset_messages(&mut self)

An interface to Simulation.reset_messages.

pub fn reset_global_time(&mut self)

An interface to Simulation.reset_global_time

pub fn inject_input_json(&mut self, message: &str)

A JS/WASM interface for Simulation.inject_input, which uses a JSON representation of the injected messages.

pub fn inject_input_yaml(&mut self, message: &str)

A JS/WASM interface for Simulation.inject_input, which uses a YAML representation of the injected messages.

pub fn step_js(&mut self) -> Array

A JS/WASM interface for Simulation.step, which converts the returned messages to a JavaScript Array.

pub fn step_json(&mut self) -> String

A JS/WASM interface for Simulation.step, which converts the returned messages to a JSON string.

pub fn step_yaml(&mut self) -> String

A JS/WASM interface for Simulation.step, which converts the returned messages to a YAML string.

pub fn step_until_js(&mut self, until: f64) -> Array

A JS/WASM interface for Simulation.step_until, which converts the returned messages to a JavaScript Array.

pub fn step_until_json(&mut self, until: f64) -> String

A JS/WASM interface for Simulation.step_until, which converts the returned messages to a JSON string.

pub fn step_until_yaml(&mut self, until: f64) -> String

A JS/WASM interface for Simulation.step_until, which converts the returned messages to a YAML string.

pub fn step_n_js(&mut self, n: usize) -> Array

A JS/WASM interface for Simulation.step_n, which converts the returned messages to a JavaScript Array.

pub fn step_n_json(&mut self, n: usize) -> String

A JS/WASM interface for Simulation.step_n, which converts the returned messages to a JSON string.

pub fn step_n_yaml(&mut self, n: usize) -> String

A JS/WASM interface for Simulation.step_n, which converts the returned messages to a YAML string.

Trait Implementations

impl Default for WebSimulation

fn default() -> WebSimulation

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for WebSimulation

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl FromWasmAbi for WebSimulation

type Abi = u32

The wasm ABI type that this converts from when coming back out from the ABI boundary.

unsafe fn from_abi(js: u32) -> Self

Recover a Self from Self::Abi.

impl IntoWasmAbi for WebSimulation

type Abi = u32

The wasm ABI type that this converts into when crossing the ABI boundary.

fn into_abi(self) -> u32

Convert self into Self::Abi so that it can be sent across the wasm ABI boundary.

impl OptionFromWasmAbi for WebSimulation

fn is_none(abi: &Self::Abi) -> bool

Tests whether the argument is a “none” instance. If so it will be deserialized as None, and otherwise it will be passed to FromWasmAbi.

impl OptionIntoWasmAbi for WebSimulation

fn none() -> Self::Abi

Returns an ABI instance indicating “none”, which JS will interpret as the None branch of this option.

impl RefFromWasmAbi for WebSimulation

type Abi = u32

The wasm ABI type references to Self are recovered from.

type Anchor = Ref<'static, WebSimulation>

The type that holds the reference to Self for the duration of the invocation of the function that has an &Self parameter. This is required to ensure that the lifetimes don’t persist beyond one function call, and so that they remain anonymous.

unsafe fn ref_from_abi(js: Self::Abi) -> Self::Anchor

Recover a Self::Anchor from Self::Abi.

impl RefMutFromWasmAbi for WebSimulation

type Abi = u32

Same as RefFromWasmAbi::Abi

type Anchor = RefMut<'static, WebSimulation>

Same as RefFromWasmAbi::Anchor

unsafe fn ref_mut_from_abi(js: Self::Abi) -> Self::Anchor

Same as RefFromWasmAbi::ref_from_abi

impl Serialize for WebSimulation

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl WasmDescribe for WebSimulation

fn describe()