Struct JsWorkerBuilder 

pub struct JsWorkerBuilder { /* private fields */ }

Available on crate features js and std only.

Builder to configure and spawn a JsWorker.

Implementations

impl JsWorkerBuilder

pub fn with_queue_capacity(self, capacity: usize) -> JsWorkerBuilder

Capacity of the worker’s job queue (defaults to JsWorker::DEFAULT_QUEUE_CAPACITY).

The queue is bounded so a stalled worker exerts backpressure on its callers instead of accumulating jobs without limit: once full, callers wait (async) for a slot.

pub fn set_queue_capacity(&mut self, capacity: usize) -> &mut JsWorkerBuilder

Capacity of the worker’s job queue (defaults to JsWorker::DEFAULT_QUEUE_CAPACITY).

The queue is bounded so a stalled worker exerts backpressure on its callers instead of accumulating jobs without limit: once full, callers wait (async) for a slot.

pub fn maybe_with_timeout(self, timeout: Option<Duration>) -> JsWorkerBuilder

Fail jobs with JsErrorKind::Timeout when their result did not arrive within the given duration, queue time included (defaults to None: callers wait indefinitely).

A queued timed-out job is cancelled before execution. A job that already entered the runtime keeps running, bounded by the runtime’s limits. Give the runtime an execution time limit to bound the job itself (at the cost of the worker when it fires). Requires a tokio runtime with timers enabled.

pub fn maybe_set_timeout( &mut self, timeout: Option<Duration>, ) -> &mut JsWorkerBuilder

Fail jobs with JsErrorKind::Timeout when their result did not arrive within the given duration, queue time included (defaults to None: callers wait indefinitely).

A queued timed-out job is cancelled before execution. A job that already entered the runtime keeps running, bounded by the runtime’s limits. Give the runtime an execution time limit to bound the job itself (at the cost of the worker when it fires). Requires a tokio runtime with timers enabled.

pub fn with_timeout(self, timeout: Duration) -> JsWorkerBuilder

Fail jobs with JsErrorKind::Timeout when their result did not arrive within the given duration, queue time included (defaults to None: callers wait indefinitely).

A queued timed-out job is cancelled before execution. A job that already entered the runtime keeps running, bounded by the runtime’s limits. Give the runtime an execution time limit to bound the job itself (at the cost of the worker when it fires). Requires a tokio runtime with timers enabled.

pub fn set_timeout(&mut self, timeout: Duration) -> &mut JsWorkerBuilder

Fail jobs with JsErrorKind::Timeout when their result did not arrive within the given duration, queue time included (defaults to None: callers wait indefinitely).

A queued timed-out job is cancelled before execution. A job that already entered the runtime keeps running, bounded by the runtime’s limits. Give the runtime an execution time limit to bound the job itself (at the cost of the worker when it fires). Requires a tokio runtime with timers enabled.

pub fn without_timeout(self) -> JsWorkerBuilder

Fail jobs with JsErrorKind::Timeout when their result did not arrive within the given duration, queue time included (defaults to None: callers wait indefinitely).

A queued timed-out job is cancelled before execution. A job that already entered the runtime keeps running, bounded by the runtime’s limits. Give the runtime an execution time limit to bound the job itself (at the cost of the worker when it fires). Requires a tokio runtime with timers enabled.

pub fn unset_timeout(&mut self) -> &mut JsWorkerBuilder

Fail jobs with JsErrorKind::Timeout when their result did not arrive within the given duration, queue time included (defaults to None: callers wait indefinitely).

A queued timed-out job is cancelled before execution. A job that already entered the runtime keeps running, bounded by the runtime’s limits. Give the runtime an execution time limit to bound the job itself (at the cost of the worker when it fires). Requires a tokio runtime with timers enabled.

pub fn maybe_with_graceful( self, guard: Option<ShutdownGuard>, ) -> JsWorkerBuilder

Tie the worker to a graceful shutdown guard (see rama_core::graceful).

Once shutdown triggers, the worker finishes the jobs already accepted into its queue and exits; the shutdown in turn waits for that, as the worker thread holds the guard until it exits. Spawning a graceful worker requires an ambient tokio runtime.

pub fn maybe_set_graceful( &mut self, guard: Option<ShutdownGuard>, ) -> &mut JsWorkerBuilder

Tie the worker to a graceful shutdown guard (see rama_core::graceful).

Once shutdown triggers, the worker finishes the jobs already accepted into its queue and exits; the shutdown in turn waits for that, as the worker thread holds the guard until it exits. Spawning a graceful worker requires an ambient tokio runtime.

pub fn with_graceful(self, guard: ShutdownGuard) -> JsWorkerBuilder

Tie the worker to a graceful shutdown guard (see rama_core::graceful).

Once shutdown triggers, the worker finishes the jobs already accepted into its queue and exits; the shutdown in turn waits for that, as the worker thread holds the guard until it exits. Spawning a graceful worker requires an ambient tokio runtime.

pub fn set_graceful(&mut self, guard: ShutdownGuard) -> &mut JsWorkerBuilder

Tie the worker to a graceful shutdown guard (see rama_core::graceful).

Once shutdown triggers, the worker finishes the jobs already accepted into its queue and exits; the shutdown in turn waits for that, as the worker thread holds the guard until it exits. Spawning a graceful worker requires an ambient tokio runtime.

pub fn without_graceful(self) -> JsWorkerBuilder

Tie the worker to a graceful shutdown guard (see rama_core::graceful).

Once shutdown triggers, the worker finishes the jobs already accepted into its queue and exits; the shutdown in turn waits for that, as the worker thread holds the guard until it exits. Spawning a graceful worker requires an ambient tokio runtime.

pub fn unset_graceful(&mut self) -> &mut JsWorkerBuilder

Tie the worker to a graceful shutdown guard (see rama_core::graceful).

Once shutdown triggers, the worker finishes the jobs already accepted into its queue and exits; the shutdown in turn waits for that, as the worker thread holds the guard until it exits. Spawning a graceful worker requires an ambient tokio runtime.

pub fn maybe_with_thread_guard( self, guard: Option<Arc<dyn Send + Sync>>, ) -> JsWorkerBuilder

Keep an opaque value alive for exactly the lifetime of the worker thread (defaults to None).

The value moves into the thread before its runtime is built and is dropped when the thread exits, including after a panic. This lets a caller observe thread lifetime through a corresponding weak handle without coupling the worker to a particular accounting policy.

pub fn maybe_set_thread_guard( &mut self, guard: Option<Arc<dyn Send + Sync>>, ) -> &mut JsWorkerBuilder

Keep an opaque value alive for exactly the lifetime of the worker thread (defaults to None).

The value moves into the thread before its runtime is built and is dropped when the thread exits, including after a panic. This lets a caller observe thread lifetime through a corresponding weak handle without coupling the worker to a particular accounting policy.

pub fn with_thread_guard(self, guard: Arc<dyn Send + Sync>) -> JsWorkerBuilder

Keep an opaque value alive for exactly the lifetime of the worker thread (defaults to None).

The value moves into the thread before its runtime is built and is dropped when the thread exits, including after a panic. This lets a caller observe thread lifetime through a corresponding weak handle without coupling the worker to a particular accounting policy.

pub fn set_thread_guard( &mut self, guard: Arc<dyn Send + Sync>, ) -> &mut JsWorkerBuilder

Keep an opaque value alive for exactly the lifetime of the worker thread (defaults to None).

The value moves into the thread before its runtime is built and is dropped when the thread exits, including after a panic. This lets a caller observe thread lifetime through a corresponding weak handle without coupling the worker to a particular accounting policy.

pub fn without_thread_guard(self) -> JsWorkerBuilder

Keep an opaque value alive for exactly the lifetime of the worker thread (defaults to None).

The value moves into the thread before its runtime is built and is dropped when the thread exits, including after a panic. This lets a caller observe thread lifetime through a corresponding weak handle without coupling the worker to a particular accounting policy.

pub fn unset_thread_guard(&mut self) -> &mut JsWorkerBuilder

Keep an opaque value alive for exactly the lifetime of the worker thread (defaults to None).

The value moves into the thread before its runtime is built and is dropped when the thread exits, including after a panic. This lets a caller observe thread lifetime through a corresponding weak handle without coupling the worker to a particular accounting policy.

pub fn spawn(self, runtime: JsRuntimeBuilder) -> Result<JsWorker, JsError>

Spawn a worker thread owning a fresh JsRuntime built from the given builder.

Trait Implementations

impl Debug for JsWorkerBuilder

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

Formats the value using the given formatter.

impl Default for JsWorkerBuilder

fn default() -> JsWorkerBuilder

Returns the “default value” for a type.