Struct Runtime

pub struct Runtime { /* private fields */ }

The async runtime of compio. It is a thread local runtime, and cannot be sent to other threads.

Implementations

impl Runtime

pub fn new() -> Result<Self>

Create Runtime with default config.

pub fn builder() -> RuntimeBuilder

Create a builder for Runtime.

pub fn try_with_current<T, F: FnOnce(&Self) -> T>(f: F) -> Result<T, F>

Try to perform a function on the current runtime, and if no runtime is running, return the function back.

pub fn with_current<T, F: FnOnce(&Self) -> T>(f: F) -> T

Perform a function on the current runtime.

Panics

This method will panic if there are no running Runtime.

pub fn enter<T, F: FnOnce() -> T>(&self, f: F) -> T

Set this runtime as current runtime, and perform a function in the current scope.

pub unsafe fn spawn_unchecked<F: Future>(&self, future: F) -> Task<F::Output>

Spawns a new asynchronous task, returning a Task for it.

Safety

The caller should ensure the captured lifetime long enough.

pub fn run(&self) -> bool

Low level API to control the runtime.

Run the scheduled tasks.

The return value indicates whether there are still tasks in the queue.

pub fn block_on<F: Future>(&self, future: F) -> F::Output

Block on the future till it completes.

pub fn spawn<F: Future + 'static>(&self, future: F) -> JoinHandle<F::Output>

Spawns a new asynchronous task, returning a Task for it.

Spawning a task enables the task to execute concurrently to other tasks. There is no guarantee that a spawned task will execute to completion.

pub fn spawn_blocking<T: Send + 'static>( &self, f: impl FnOnce() -> T + Send + Sync + 'static, ) -> JoinHandle<T>

Spawns a blocking task in a new thread, and wait for it.

The task will not be cancelled even if the future is dropped.

pub fn attach(&self, fd: RawFd) -> Result<()>

Attach a raw file descriptor/handle/socket to the runtime.

You only need this when authoring your own high-level APIs. High-level resources in this crate are attached automatically.

pub fn submit<T: OpCode + 'static>( &self, op: T, ) -> impl Future<Output = BufResult<usize, T>>

Submit an operation to the runtime.

You only need this when authoring your own OpCode.

pub fn submit_with_flags<T: OpCode + 'static>( &self, op: T, ) -> impl Future<Output = (BufResult<usize, T>, u32)>

Submit an operation to the runtime.

The difference between Runtime::submit is this method will return the flags

You only need this when authoring your own OpCode.

pub fn current_timeout(&self) -> Option<Duration>

Low level API to control the runtime.

Get the timeout value to be passed to Proactor::poll.

pub fn poll(&self)

Low level API to control the runtime.

Poll the inner proactor. It is equal to calling Runtime::poll_with with Runtime::current_timeout.

pub fn poll_with(&self, timeout: Option<Duration>)

Low level API to control the runtime.

Poll the inner proactor with a custom timeout.

Trait Implementations

impl AsRawFd for Runtime

fn as_raw_fd(&self) -> RawFd

Extracts the raw file descriptor.

impl AsyncExecutor for &Runtime

Available on crate feature criterion only.

fn block_on<T>(&self, future: impl Future<Output = T>) -> T

Spawn the given future onto this runtime and block until it’s complete, returning the result.

impl AsyncExecutor for Runtime

Available on crate feature criterion only.

fn block_on<T>(&self, future: impl Future<Output = T>) -> T

Spawn the given future onto this runtime and block until it’s complete, returning the result.

impl Drop for Runtime

fn drop(&mut self)

Executes the destructor for this type.