Struct TsRuntimeConfig

#[non_exhaustive]
pub struct TsRuntimeConfig {
    pub msgpack_module: String,
    pub generate_raw_export_wrappers: bool,
    pub streaming_instantiation: bool,
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

msgpack_module: String

The module from which to import the MessagePack dependency.

By default, “@msgpack/msgpack” is used, which should work with Node.js and most NPM-based bundlers. If you use Deno, you may wish to specify “https://unpkg.com/@msgpack/msgpack/mod.ts”.

generate_raw_export_wrappers: bool

Whether or not to generate raw export wrappers.

Raw export wrappers allow you to call fp_export! functions from the runtime while passing raw MessagePack data, which you can use in some situations to avoid (de)serialization overhead. If you don’t need these wrappers, you can omit them to optimize your bundle size.

Raw export wrappers are named similarly to the regular wrappers (which are generated in any case), but with a Raw suffix.

streaming_instantiation: bool

Use WebAssembly.instantiateStreaming() instead of WebAssembly.instantiate() for optimizing instantiation in browser use cases. This changes the signature of the createRuntime() function to accept a Response instead of an ArrayBuffer.

See also: https://developer.mozilla.org/en-US/docs/WebAssembly/JavaScript_interface/instantiateStreaming

This setting is true by default, since MDN recommends it where possible. You may wish to opt-out if you’re using the runtime in an environment that doesn’t support streaming instantiation, such as Node.js.

Implementations

impl TsRuntimeConfig

pub fn new() -> Self

Returns a new config instance with default settings.

pub fn with_msgpack_module(self, msgpack_module: &str) -> Self

Sets the msgpack_module setting.

pub fn with_raw_export_wrappers(self) -> Self

Enables the generate_raw_export_wrappers setting.

pub fn without_streaming_instantiation(self) -> Self

Disables the streaming_instantiation setting.

Trait Implementations

impl Clone for TsRuntimeConfig

fn clone(&self) -> TsRuntimeConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TsRuntimeConfig

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

Formats the value using the given formatter.

impl Default for TsRuntimeConfig

fn default() -> Self

Returns the “default value” for a type.