Struct RuntimeBuilder 

pub struct RuntimeBuilder { /* private fields */ }

Available on crate feature std only.

Builder for a dedicated blocking-boundary Runtime.

Implementations

impl RuntimeBuilder

pub fn new() -> RuntimeBuilder

Create a runtime builder with default settings.

pub fn with_thread_name(self, name: impl Into<String>) -> RuntimeBuilder

Set the name of the dedicated runtime owner thread.

pub fn set_thread_name( &mut self, name: impl Into<String>, ) -> &mut RuntimeBuilder

Set the name of the dedicated runtime owner thread.

pub fn with_shutdown_timeout(self, timeout: Duration) -> RuntimeBuilder

Set the maximum time spent shutting down Tokio work when the final runtime lease is dropped.

pub fn set_shutdown_timeout(&mut self, timeout: Duration) -> &mut RuntimeBuilder

Set the maximum time spent shutting down Tokio work when the final runtime lease is dropped.

pub fn with_current_thread(self) -> RuntimeBuilder

Use a current-thread Tokio scheduler.

With the dial9 feature, this overrides the implicit environment config when telemetry is disabled. Enabled telemetry needs the multi-thread scheduler and conflicts with this setting.

pub fn set_current_thread(&mut self) -> &mut RuntimeBuilder

Use a current-thread Tokio scheduler.

With the dial9 feature, this overrides the implicit environment config when telemetry is disabled. Enabled telemetry needs the multi-thread scheduler and conflicts with this setting.

pub fn with_worker_threads(self, worker_threads: usize) -> RuntimeBuilder

Use a multi-thread Tokio scheduler.

With the dial9 feature, this overrides the implicit environment config when telemetry is disabled, and its worker count applies to the instrumented runtime otherwise.

pub fn set_worker_threads( &mut self, worker_threads: usize, ) -> &mut RuntimeBuilder

Use a multi-thread Tokio scheduler.

With the dial9 feature, this overrides the implicit environment config when telemetry is disabled, and its worker count applies to the instrumented runtime otherwise.

pub fn maybe_with_dial9_recorder( self, dial9_recorder: Option<Recorder>, ) -> RuntimeBuilder

Set the Recorder this runtime records into.

With the dial9 feature, this defaults to resolving the DIAL9_* environment when the runtime is built. Combining an enabled recorder with with_current_thread is rejected by try_build. An implicit environment config yields to an explicit Rama scheduler when telemetry is disabled. Use without_dial9_recorder to explicitly select a Rama-configured scheduler without dial9.

An enabled recorder must produce a multi-thread runtime because dial9 installs ambient telemetry handles on Tokio-owned worker threads.

pub fn maybe_set_dial9_recorder( &mut self, dial9_recorder: Option<Recorder>, ) -> &mut RuntimeBuilder

Set the Recorder this runtime records into.

With the dial9 feature, this defaults to resolving the DIAL9_* environment when the runtime is built. Combining an enabled recorder with with_current_thread is rejected by try_build. An implicit environment config yields to an explicit Rama scheduler when telemetry is disabled. Use without_dial9_recorder to explicitly select a Rama-configured scheduler without dial9.

An enabled recorder must produce a multi-thread runtime because dial9 installs ambient telemetry handles on Tokio-owned worker threads.

pub fn with_dial9_recorder(self, dial9_recorder: Recorder) -> RuntimeBuilder

Set the Recorder this runtime records into.

With the dial9 feature, this defaults to resolving the DIAL9_* environment when the runtime is built. Combining an enabled recorder with with_current_thread is rejected by try_build. An implicit environment config yields to an explicit Rama scheduler when telemetry is disabled. Use without_dial9_recorder to explicitly select a Rama-configured scheduler without dial9.

An enabled recorder must produce a multi-thread runtime because dial9 installs ambient telemetry handles on Tokio-owned worker threads.

pub fn set_dial9_recorder( &mut self, dial9_recorder: Recorder, ) -> &mut RuntimeBuilder

Set the Recorder this runtime records into.

With the dial9 feature, this defaults to resolving the DIAL9_* environment when the runtime is built. Combining an enabled recorder with with_current_thread is rejected by try_build. An implicit environment config yields to an explicit Rama scheduler when telemetry is disabled. Use without_dial9_recorder to explicitly select a Rama-configured scheduler without dial9.

An enabled recorder must produce a multi-thread runtime because dial9 installs ambient telemetry handles on Tokio-owned worker threads.

pub fn without_dial9_recorder(self) -> RuntimeBuilder

Set the Recorder this runtime records into.

With the dial9 feature, this defaults to resolving the DIAL9_* environment when the runtime is built. Combining an enabled recorder with with_current_thread is rejected by try_build. An implicit environment config yields to an explicit Rama scheduler when telemetry is disabled. Use without_dial9_recorder to explicitly select a Rama-configured scheduler without dial9.

An enabled recorder must produce a multi-thread runtime because dial9 installs ambient telemetry handles on Tokio-owned worker threads.

pub fn unset_dial9_recorder(&mut self) -> &mut RuntimeBuilder

Set the Recorder this runtime records into.

With the dial9 feature, this defaults to resolving the DIAL9_* environment when the runtime is built. Combining an enabled recorder with with_current_thread is rejected by try_build. An implicit environment config yields to an explicit Rama scheduler when telemetry is disabled. Use without_dial9_recorder to explicitly select a Rama-configured scheduler without dial9.

An enabled recorder must produce a multi-thread runtime because dial9 installs ambient telemetry handles on Tokio-owned worker threads.

pub fn with_dial9_attach_options( self, dial9_attach_options: TokioAttachOptions, ) -> RuntimeBuilder

Set how this runtime is traced: task tracking, dumps, hooks, and its name in the trace.

Applies alongside with_dial9_recorder. The implicit environment path configures itself from DIAL9_*, so combining options with it is rejected by try_build; with telemetry explicitly disabled the options are moot. When unset, the runtime takes this builder’s thread name. Set options and you name it yourself.

pub fn set_dial9_attach_options( &mut self, dial9_attach_options: TokioAttachOptions, ) -> &mut RuntimeBuilder

Set how this runtime is traced: task tracking, dumps, hooks, and its name in the trace.

Applies alongside with_dial9_recorder. The implicit environment path configures itself from DIAL9_*, so combining options with it is rejected by try_build; with telemetry explicitly disabled the options are moot. When unset, the runtime takes this builder’s thread name. Set options and you name it yourself.

pub fn try_build(self) -> Result<Runtime, Error>

Build the dedicated runtime.

Trait Implementations

impl Debug for RuntimeBuilder

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

Formats the value using the given formatter.

impl Default for RuntimeBuilder

fn default() -> RuntimeBuilder

Returns the “default value” for a type.