Skip to main content

JsRuntimeBuilder

Struct JsRuntimeBuilder 

pub struct JsRuntimeBuilder { /* private fields */ }
Available on crate features js and std only.
Expand description

Builder to configure and create a JsRuntime.

Cloneable, so it can double as a reusable blueprint: registered values share their backing storage and host functions are shared, making clones cheap. One blueprint can back any number of JsRuntimes and JsWorkers.

Implementations§

§

impl JsRuntimeBuilder

pub const DEFAULT_LOOP_ITERATION_LIMIT: u64 = 1_000_000

Default instruction-fuel budget, expressed in approximate loop iterations for compatibility with the original API.

pub const DEFAULT_MEMORY_LIMIT: usize

Default maximum memory available to the private WebAssembly engine.

pub fn with_strict(self, strict: bool) -> JsRuntimeBuilder

Evaluate all scripts in strict mode, regardless of "use strict" directives.

pub fn set_strict(&mut self, strict: bool) -> &mut JsRuntimeBuilder

Evaluate all scripts in strict mode, regardless of "use strict" directives.

pub fn maybe_with_loop_iteration_limit( self, limit: Option<u64>, ) -> JsRuntimeBuilder

Limit script work with deterministic WebAssembly instruction fuel.

The value is scaled to preserve the existing approximate loop-count configuration. Unlike the original per-frame guard, the budget is cumulative across the complete evaluation or function call.

Defaults to Self::DEFAULT_LOOP_ITERATION_LIMIT; None removes the limit entirely. Exceeding it fails the evaluation with JsErrorKind::LimitExceeded.

pub fn maybe_set_loop_iteration_limit( &mut self, limit: Option<u64>, ) -> &mut JsRuntimeBuilder

Limit script work with deterministic WebAssembly instruction fuel.

The value is scaled to preserve the existing approximate loop-count configuration. Unlike the original per-frame guard, the budget is cumulative across the complete evaluation or function call.

Defaults to Self::DEFAULT_LOOP_ITERATION_LIMIT; None removes the limit entirely. Exceeding it fails the evaluation with JsErrorKind::LimitExceeded.

pub fn with_loop_iteration_limit(self, limit: u64) -> JsRuntimeBuilder

Limit script work with deterministic WebAssembly instruction fuel.

The value is scaled to preserve the existing approximate loop-count configuration. Unlike the original per-frame guard, the budget is cumulative across the complete evaluation or function call.

Defaults to Self::DEFAULT_LOOP_ITERATION_LIMIT; None removes the limit entirely. Exceeding it fails the evaluation with JsErrorKind::LimitExceeded.

pub fn set_loop_iteration_limit(&mut self, limit: u64) -> &mut JsRuntimeBuilder

Limit script work with deterministic WebAssembly instruction fuel.

The value is scaled to preserve the existing approximate loop-count configuration. Unlike the original per-frame guard, the budget is cumulative across the complete evaluation or function call.

Defaults to Self::DEFAULT_LOOP_ITERATION_LIMIT; None removes the limit entirely. Exceeding it fails the evaluation with JsErrorKind::LimitExceeded.

pub fn without_loop_iteration_limit(self) -> JsRuntimeBuilder

Limit script work with deterministic WebAssembly instruction fuel.

The value is scaled to preserve the existing approximate loop-count configuration. Unlike the original per-frame guard, the budget is cumulative across the complete evaluation or function call.

Defaults to Self::DEFAULT_LOOP_ITERATION_LIMIT; None removes the limit entirely. Exceeding it fails the evaluation with JsErrorKind::LimitExceeded.

pub fn unset_loop_iteration_limit(&mut self) -> &mut JsRuntimeBuilder

Limit script work with deterministic WebAssembly instruction fuel.

The value is scaled to preserve the existing approximate loop-count configuration. Unlike the original per-frame guard, the budget is cumulative across the complete evaluation or function call.

Defaults to Self::DEFAULT_LOOP_ITERATION_LIMIT; None removes the limit entirely. Exceeding it fails the evaluation with JsErrorKind::LimitExceeded.

pub fn with_memory_limit(self, limit: usize) -> JsRuntimeBuilder

Set the maximum memory available to the private WebAssembly engine.

This includes the JavaScript heap and engine state. Memory growth beyond the limit traps inside the WebAssembly container and poisons the runtime. Defaults to Self::DEFAULT_MEMORY_LIMIT.

pub fn set_memory_limit(&mut self, limit: usize) -> &mut JsRuntimeBuilder

Set the maximum memory available to the private WebAssembly engine.

This includes the JavaScript heap and engine state. Memory growth beyond the limit traps inside the WebAssembly container and poisons the runtime. Defaults to Self::DEFAULT_MEMORY_LIMIT.

pub fn maybe_with_execution_time_limit( self, limit: Option<Duration>, ) -> JsRuntimeBuilder

Wall-clock limit on each evaluation or call.

Wasmtime epoch interruption bounds all execution inside the engine component, including parsing, compilation, built-ins, snapshotting, and drained microtasks. The check is coarse-grained and does not run while a registered Rust host callback is executing.

Exceeding it fails the evaluation with JsErrorKind::LimitExceeded and poisons the runtime (JsRuntime::is_poisoned): the engine was aborted mid-execution, so every later operation fails with JsErrorKind::Setup. A JsWorker whose runtime got poisoned exits, failing pending jobs fast (fail-loud, like a panicking host function).

The frozen __rama_js_call__ global remains reserved for API compatibility and never exposes host data.

Defaults to None: no time limit.

pub fn maybe_set_execution_time_limit( &mut self, limit: Option<Duration>, ) -> &mut JsRuntimeBuilder

Wall-clock limit on each evaluation or call.

Wasmtime epoch interruption bounds all execution inside the engine component, including parsing, compilation, built-ins, snapshotting, and drained microtasks. The check is coarse-grained and does not run while a registered Rust host callback is executing.

Exceeding it fails the evaluation with JsErrorKind::LimitExceeded and poisons the runtime (JsRuntime::is_poisoned): the engine was aborted mid-execution, so every later operation fails with JsErrorKind::Setup. A JsWorker whose runtime got poisoned exits, failing pending jobs fast (fail-loud, like a panicking host function).

The frozen __rama_js_call__ global remains reserved for API compatibility and never exposes host data.

Defaults to None: no time limit.

pub fn with_execution_time_limit(self, limit: Duration) -> JsRuntimeBuilder

Wall-clock limit on each evaluation or call.

Wasmtime epoch interruption bounds all execution inside the engine component, including parsing, compilation, built-ins, snapshotting, and drained microtasks. The check is coarse-grained and does not run while a registered Rust host callback is executing.

Exceeding it fails the evaluation with JsErrorKind::LimitExceeded and poisons the runtime (JsRuntime::is_poisoned): the engine was aborted mid-execution, so every later operation fails with JsErrorKind::Setup. A JsWorker whose runtime got poisoned exits, failing pending jobs fast (fail-loud, like a panicking host function).

The frozen __rama_js_call__ global remains reserved for API compatibility and never exposes host data.

Defaults to None: no time limit.

pub fn set_execution_time_limit( &mut self, limit: Duration, ) -> &mut JsRuntimeBuilder

Wall-clock limit on each evaluation or call.

Wasmtime epoch interruption bounds all execution inside the engine component, including parsing, compilation, built-ins, snapshotting, and drained microtasks. The check is coarse-grained and does not run while a registered Rust host callback is executing.

Exceeding it fails the evaluation with JsErrorKind::LimitExceeded and poisons the runtime (JsRuntime::is_poisoned): the engine was aborted mid-execution, so every later operation fails with JsErrorKind::Setup. A JsWorker whose runtime got poisoned exits, failing pending jobs fast (fail-loud, like a panicking host function).

The frozen __rama_js_call__ global remains reserved for API compatibility and never exposes host data.

Defaults to None: no time limit.

pub fn without_execution_time_limit(self) -> JsRuntimeBuilder

Wall-clock limit on each evaluation or call.

Wasmtime epoch interruption bounds all execution inside the engine component, including parsing, compilation, built-ins, snapshotting, and drained microtasks. The check is coarse-grained and does not run while a registered Rust host callback is executing.

Exceeding it fails the evaluation with JsErrorKind::LimitExceeded and poisons the runtime (JsRuntime::is_poisoned): the engine was aborted mid-execution, so every later operation fails with JsErrorKind::Setup. A JsWorker whose runtime got poisoned exits, failing pending jobs fast (fail-loud, like a panicking host function).

The frozen __rama_js_call__ global remains reserved for API compatibility and never exposes host data.

Defaults to None: no time limit.

pub fn unset_execution_time_limit(&mut self) -> &mut JsRuntimeBuilder

Wall-clock limit on each evaluation or call.

Wasmtime epoch interruption bounds all execution inside the engine component, including parsing, compilation, built-ins, snapshotting, and drained microtasks. The check is coarse-grained and does not run while a registered Rust host callback is executing.

Exceeding it fails the evaluation with JsErrorKind::LimitExceeded and poisons the runtime (JsRuntime::is_poisoned): the engine was aborted mid-execution, so every later operation fails with JsErrorKind::Setup. A JsWorker whose runtime got poisoned exits, failing pending jobs fast (fail-loud, like a panicking host function).

The frozen __rama_js_call__ global remains reserved for API compatibility and never exposes host data.

Defaults to None: no time limit.

pub fn with_snapshot_limits(self, limits: JsSnapshotLimits) -> JsRuntimeBuilder

Configure resource limits for values copied out of the JS engine.

These limits apply to results, thrown values, and host-function arguments. The safe defaults are defined by JsSnapshotLimits.

pub fn set_snapshot_limits( &mut self, limits: JsSnapshotLimits, ) -> &mut JsRuntimeBuilder

Configure resource limits for values copied out of the JS engine.

These limits apply to results, thrown values, and host-function arguments. The safe defaults are defined by JsSnapshotLimits.

pub fn with_global( self, name: impl Into<JsStr>, global: impl IntoJsGlobal, ) -> JsRuntimeBuilder

Register a global: a value convertible Into<JsValue>, or a JsNamespace host object.

pub fn set_global( &mut self, name: impl Into<JsStr>, global: impl IntoJsGlobal, ) -> &mut JsRuntimeBuilder

Register a global: a value convertible Into<JsValue>, or a JsNamespace host object.

pub fn with_fn<A, F>(self, name: impl Into<JsStr>, f: F) -> JsRuntimeBuilder
where F: JsFn<A>,

Register a global host function with typed, extractor-style arguments (see JsFn).

pub fn set_fn<A, F>( &mut self, name: impl Into<JsStr>, f: F, ) -> &mut JsRuntimeBuilder
where F: JsFn<A>,

Register a global host function with typed, extractor-style arguments (see JsFn).

pub fn build(self) -> Result<JsRuntime, JsError>

Build the configured JsRuntime.

Trait Implementations§

§

impl Clone for JsRuntimeBuilder

§

fn clone(&self) -> JsRuntimeBuilder

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
§

impl Debug for JsRuntimeBuilder

§

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

Formats the value using the given formatter. Read more
§

impl Default for JsRuntimeBuilder

§

fn default() -> JsRuntimeBuilder

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
§

impl<'a, T, E> AsTaggedExplicit<'a, E> for T
where T: 'a,

§

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self, E>

§

impl<'a, T, E> AsTaggedImplicit<'a, E> for T
where T: 'a,

§

fn implicit( self, class: Class, constructed: bool, tag: u32, ) -> TaggedParser<'a, Implicit, Self, E>

Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> FromRef<T> for T
where T: Clone,

§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
§

impl<T> FutureExt for T

§

fn with_context(self, otel_cx: Context) -> WithContext<Self>

Attaches the provided Context to this type, returning a WithContext wrapper. Read more
§

fn with_current_context(self) -> WithContext<Self>

Attaches the current Context to this type, returning a WithContext wrapper. Read more
§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

impl<T> IntoRequest<T> for T

§

fn into_request(self) -> Request<T>

Wrap the input message T in a rama_grpc::Request
§

impl<L> LayerExt<L> for L

§

fn named_layer<S>(&self, service: S) -> Layered<<L as Layer<S>>::Service, S>
where L: Layer<S>,

Applies the layer to a service and wraps it in Layered.
§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
§

impl<T> PolicyExt for T
where T: ?Sized,

§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
§

impl<T, U> RamaFrom<T> for U
where U: From<T>,

§

fn rama_from(value: T) -> U

§

impl<T, U, CrateMarker> RamaInto<U, CrateMarker> for T
where U: RamaFrom<T, CrateMarker>,

§

fn rama_into(self) -> U

§

impl<T, U> RamaTryFrom<T> for U
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

§

fn rama_try_from(value: T) -> Result<U, <U as RamaTryFrom<T>>::Error>

§

impl<T, U, CrateMarker> RamaTryInto<U, CrateMarker> for T
where U: RamaTryFrom<T, CrateMarker>,

§

type Error = <U as RamaTryFrom<T, CrateMarker>>::Error

§

fn rama_try_into(self) -> Result<U, <U as RamaTryFrom<T, CrateMarker>>::Error>

§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<V, F> ValueFormatter<&V> for F
where F: ValueFormatter<V> + ?Sized, V: ?Sized,

§

const SHAPE: FieldShape<'static>

Available on non-metrique_require_explicit_impls only.
The shape of values produced by this formatter. Read more
§

fn format_value(writer: impl ValueWriter, value: &&V)

Write value to writer
§

impl<V, F> ValueFormatter<Arc<V>> for F
where F: ValueFormatter<V> + ?Sized, V: ?Sized,

§

const SHAPE: FieldShape<'static>

Available on non-metrique_require_explicit_impls only.
The shape of values produced by this formatter. Read more
§

fn format_value(writer: impl ValueWriter, value: &Arc<V>)

Write value to writer
§

impl<V, F> ValueFormatter<Box<V>> for F
where F: ValueFormatter<V> + ?Sized, V: ?Sized,

§

const SHAPE: FieldShape<'static>

Available on non-metrique_require_explicit_impls only.
The shape of values produced by this formatter. Read more
§

fn format_value(writer: impl ValueWriter, value: &Box<V>)

Write value to writer
§

impl<V, F> ValueFormatter<Cow<'_, V>> for F
where V: ToOwned + ?Sized, F: ValueFormatter<V> + ?Sized,

§

const SHAPE: FieldShape<'static>

Available on non-metrique_require_explicit_impls only.
The shape of values produced by this formatter. Read more
§

fn format_value(writer: impl ValueWriter, value: &Cow<'_, V>)

Write value to writer
§

impl<V, F> ValueFormatter<Option<V>> for F
where F: ValueFormatter<V> + ?Sized,

§

const SHAPE: FieldShape<'static>

Available on non-metrique_require_explicit_impls only.
The shape of values produced by this formatter. Read more
§

fn format_value(writer: impl ValueWriter, value: &Option<V>)

Write value to writer
§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more