Struct CoreRuntime 

pub struct CoreRuntime { /* private fields */ }

Holds shared state/components needed to back instances of workers and clients. More than one may be instantiated, but typically only one is needed. More than one runtime instance may be useful if multiple different telemetry settings are required.

Implementations

impl CoreRuntime

pub fn new<F>( telemetry_options: TelemetryOptions, tokio_builder: TokioRuntimeBuilder<F>, ) -> Result<Self, Error>

where F: Fn() + Send + Sync + 'static,

Create a new core runtime with the provided telemetry options and tokio runtime builder. Also initialize telemetry for the thread this is being called on.

Note that this function will call the tokio::runtime::Builder::enable_all builder option on the Tokio runtime builder, and will call tokio::runtime::Builder::on_thread_start to ensure telemetry subscribers are set on every tokio thread.

Important: You need to call this before calling any async functions on workers or clients, otherwise the tracing subscribers will not be properly attached.

Panics

If a tokio runtime has already been initialized. To re-use an existing runtime, call CoreRuntime::new_assume_tokio.

pub fn new_assume_tokio( telemetry_options: TelemetryOptions, ) -> Result<Self, Error>

Initialize telemetry for the thread this is being called on, assuming a tokio runtime is already active and this call exists in its context. See Self::new for more.

Panics

If there is no currently active Tokio runtime

pub fn new_assume_tokio_initialized_telem(telemetry: TelemetryInstance) -> Self

Construct a runtime from an already-initialized telemetry instance, assuming a tokio runtime is already active and this call exists in its context. See Self::new for more.

Panics

If there is no currently active Tokio runtime

pub fn tokio_handle(&self) -> Handle

Get a handle to the tokio runtime used by this Core runtime.

pub fn telemetry(&self) -> &TelemetryInstance

Return a reference to the owned TelemetryInstance

pub fn telemetry_mut(&mut self) -> &mut TelemetryInstance

Return a mutable reference to the owned TelemetryInstance

Trait Implementations

impl Drop for CoreRuntime

fn drop(&mut self)

Executes the destructor for this type.