Struct CurrentThreadRuntime 

pub struct CurrentThreadRuntime { /* private fields */ }

A current thread runtime allows users to explicitly drive Vortex futures from multiple worker threads that they manage. This is useful in environments where the user already has a thread pool and wants to integrate Vortex into that pool, for example query engines.

Implementations

impl CurrentThreadRuntime

pub fn new() -> Self

Create a new current thread runtime.

pub fn block_on_stream_thread_safe<F, S, R>( &self, f: F, ) -> ThreadSafeIterator<R>

where F: FnOnce(Handle) -> S, S: Stream<Item = R> + Send + 'static, R: Send + 'static,

Returns an iterator wrapper around a stream, blocking the current thread for each item.

Multi-threaded Usage

To drive the iterator from multiple threads, simply clone it and call next() on each clone. Results on each thread are ordered with respect to the stream, but there is no ordering guarantee between threads.

Trait Implementations

impl BlockingRuntime for CurrentThreadRuntime

type BlockingIterator<'a, R: 'a> = CurrentThreadIterator<'a, R>

Associated type for the blocking iterator returned by block_on_stream.

fn handle(&self) -> Handle

Returns a handle to the runtime.

fn block_on<F, Fut, R>(&self, f: F) -> R

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

Runs a future to completion on the runtime, blocking the current thread until it completes.

fn block_on_stream<'a, F, S, R>(&self, f: F) -> Self::BlockingIterator<'a, R>

where F: FnOnce(Handle) -> S, S: Stream<Item = R> + Send + 'a, R: Send + 'a,

Returns an iterator wrapper around a stream, blocking the current thread for each item.

impl Clone for CurrentThreadRuntime

fn clone(&self) -> CurrentThreadRuntime

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for CurrentThreadRuntime

fn default() -> CurrentThreadRuntime

Returns the “default value” for a type.