Struct RuntimeBuilder

pub struct RuntimeBuilder<D> { /* private fields */ }

Runtime builder

Implementations

impl<T> RuntimeBuilder<T>

pub fn new() -> Self

Create a default runtime builder.

Note

When the sync feature is enabled, the default behavior of [monoio::blocking::BlockingStrategy] is to execute tasks on the local thread. In other words, there is no thread pool involved—all blocking I/O operations and heavy computations will block the current thread.

impl RuntimeBuilder<IoUringDriver>

pub fn build(self) -> Result<Runtime<IoUringDriver>>

Build the runtime.

impl RuntimeBuilder<TimeDriver<IoUringDriver>>

pub fn build(self) -> Result<Runtime<TimeDriver<IoUringDriver>>>

Build the runtime.

impl RuntimeBuilder<LegacyDriver>

pub fn build(self) -> Result<Runtime<LegacyDriver>>

Build the runtime.

impl RuntimeBuilder<TimeDriver<LegacyDriver>>

pub fn build(self) -> Result<Runtime<TimeDriver<LegacyDriver>>>

Build the runtime.

impl<D> RuntimeBuilder<D>

pub fn with_entries(self, entries: u32) -> Self

Set io_uring entries, min size is 256 and the default size is 1024.

pub fn uring_builder(self, urb: Builder) -> Self

Replaces the default io_uring::Builder, which controls the settings for the inner io_uring API.

Refer to the io_uring::Builder documentation for all the supported methods.

impl RuntimeBuilder<FusionDriver>

pub fn build(self) -> Result<FusionRuntime<IoUringDriver, LegacyDriver>>

Build the runtime.

impl RuntimeBuilder<TimeDriver<FusionDriver>>

pub fn build( self, ) -> Result<FusionRuntime<TimeDriver<IoUringDriver>, TimeDriver<LegacyDriver>>>

Build the runtime.

impl<D: TimeWrapable> RuntimeBuilder<D>

pub fn enable_all(self) -> RuntimeBuilder<TimeDriver<D>>

Enable all(currently only timer)

pub fn enable_timer(self) -> RuntimeBuilder<TimeDriver<D>>

Enable timer

impl<D> RuntimeBuilder<D>

pub fn attach_thread_pool( self, tp: Box<dyn ThreadPool + Send + 'static>, ) -> Self

Attach thread pool, this will overwrite blocking strategy. All spawn_blocking will be executed on given thread pool.

pub fn with_blocking_strategy(self, strategy: BlockingStrategy) -> Self

Set blocking strategy, this will overwrite thread pool setting. If BlockingStrategy::Panic is used, it will panic if spawn_blocking on this thread. If BlockingStrategy::ExecuteLocal is used, it will execute with current thread, and may cause tasks high latency. Attaching a thread pool is recommended if spawn_blocking will be used.

Trait Implementations

impl<T> Default for RuntimeBuilder<T>

fn default() -> Self

Create a default runtime builder.

Note

When the sync feature is enabled, the default behavior of [monoio::blocking::BlockingStrategy] is to execute tasks on the local thread. In other words, there is no thread pool involved—all blocking I/O operations and heavy computations will block the current thread.