Struct Handle 

pub struct Handle { /* private fields */ }

A handle to an active Vortex runtime.

Users should obtain a handle from one of the Vortex runtime’s and use it to spawn new async tasks, blocking I/O tasks, CPU-heavy tasks, or to open files for reading or writing.

Note that a Handle is a weak reference to the underlying runtime. If the associated runtime has been dropped, then any requests to spawn new tasks will panic.

Implementations

impl Handle

pub fn find() -> Option<Self>

Returns a handle to the current runtime, if such a reasonable choice exists.

For example, if called from within a Tokio context this will return a TokioRuntime handle.

pub fn spawn<Fut, R>(&self, f: Fut) -> Task<R>

where Fut: Future<Output = R> + Send + 'static, R: Send + 'static,

Spawn a new future onto the runtime.

These futures are expected to not perform expensive CPU work and instead simply schedule either CPU tasks or I/O tasks. See Handle::spawn_cpu for spawning CPU-bound work.

See Task for details on cancelling or detaching the spawned task.

pub fn spawn_nested<F, Fut, R>(&self, f: F) -> Task<R>

where F: FnOnce(Handle) -> Fut, Fut: Future<Output = R> + Send + 'static, R: Send + 'static,

A helper function to avoid manually cloning the handle when spawning nested tasks.

pub fn spawn_cpu<F, R>(&self, f: F) -> Task<R>

where F: FnOnce() -> R + Send + 'static, R: Send + 'static,

Spawn a CPU-bound task for execution on the runtime.

Note that many runtimes will interleave this work on the same async runtime. See the documentation for each runtime implementation for details.

See Task for details on cancelling or detaching the spawned work, although note that once started, CPU work cannot be cancelled.

pub fn spawn_blocking<F, R>(&self, f: F) -> Task<R>

where F: FnOnce() -> R + Send + 'static, R: Send + 'static,

Spawn a blocking I/O task for execution on the runtime.

pub fn open_read<S: IntoReadSource>( &self, source: S, metrics: VortexMetrics, ) -> VortexResult<FileRead>

Open a file for I/O on this runtime.

Trait Implementations

impl Clone for Handle

fn clone(&self) -> Handle

Returns a duplicate of the value.

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

Performs copy-assignment from source.