Struct compio_runtime::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_current() -> Option<Self>

Get the current running Runtime.

pub fn current() -> Self

Get the current running Runtime.

Panics

This method will panic if there are no running Runtime.

pub fn enter(&self) -> EnterGuard<'_>

Enter the runtime context. This runtime will be set as the current one.

Panics

When calling Runtime::enter multiple times, the returned guards must be dropped in the reverse order that they were acquired. Failure to do so will result in a panic and possible memory leaks.

Do not do the following, this shows a scenario that will result in a panic and possible memory leak.

use compio_runtime::Runtime;

let rt1 = Runtime::new().unwrap();
let rt2 = Runtime::new().unwrap();

let enter1 = rt1.enter();
let enter2 = rt2.enter();

drop(enter1);
drop(enter2);

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) -> Task<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 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.

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 Clone for Runtime

fn clone(&self) -> Runtime

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.