Struct Header 

pub struct Header {
    pub schema_version: u32,
    pub ndm: u8,
    pub engine_version: String,
    pub record_initial: bool,
}

Small structured-clone header fields — everything else in CarapaceInputV1 is a bulk table.

Fields

schema_version: u32

The wire format’s own version, independent of engine_version.

ndm: u8

Model dimension: 2 (NDM=2/NDF=3) or 3 (NDM=3/NDF=6). decode rejects any other value.

engine_version: String

carapace-core’s version, recorded for run provenance.

record_initial: bool

Record one sample of every supported recorder at the start of each Static/Transient stage, before its first step (the stage’s initial conditions, at load factor/time 0). Off by default: every stage’s samples are then only the ones its steps produce.

Trait Implementations

impl Clone for Header

fn clone(&self) -> Header

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Header

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Header

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Header

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Tsify for Header

const DECL: &'static str = "/**\n * Small structured-clone header fields \u{2014} everything else in\n * `CarapaceInputV1` is a bulk table.\n */\nexport interface Header {\n /**\n * The wire format\'s own version, independent of `engine_version`.\n */\n schemaVersion: number;\n /**\n * Model dimension: `2` (`NDM=2`/`NDF=3`) or `3` (`NDM=3`/`NDF=6`).\n * [`decode`] rejects any other value.\n */\n ndm: number;\n /**\n * `carapace-core`\'s version, recorded for run provenance.\n */\n engineVersion: string;\n /**\n * Record one sample of every supported recorder at the start of each `Static`/`Transient`\n * stage, before its first step (the stage\'s initial conditions, at load factor/time `0`).\n * Off by default: every stage\'s samples are then only the ones its steps produce.\n */\n recordInitial?: boolean;\n}"

const SERIALIZATION_CONFIG: SerializationConfig

type JsType = JsType

Must be a type imported through #[wasm_bindgen] extern "C" { .. }. [Ts<T>] is #[repr(transparent)] over this and passes it across the ABI as a plain JS handle, which any other representation would break.

fn into_js(&self) -> Result<Self::JsType, Error>

where Self: Serialize,

fn from_js<T>(js: T) -> Result<Self, Error>

where T: Into<JsValue>, Self: DeserializeOwned,

fn into_ts(&self) -> Result<Ts<Self>, Error>

where Self: Sized + Serialize,

Calls Ts::from_rust on self, returning a Result<Ts<Self>, crate::Error>.