vortex-io 0.69.0

Core async and blocking IO traits and implementations, used by IPC and file format
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29

// SPDX-License-Identifier: Apache-2.0
// SPDX-FileCopyrightText: Copyright the Vortex contributors

use futures::Stream;

use crate::runtime::Handle;

/// A generic API blocking entry points to runtimes.
pub trait BlockingRuntime {
    /// Associated type for the blocking iterator returned by `block_on_stream`.
    type BlockingIterator<'a, R: 'a>: Iterator<Item = R> + 'a;

    /// Returns a handle to the runtime.
    fn handle(&self) -> Handle;

    /// Runs a future to completion on the runtime, blocking the current thread until it completes.
    ///
    /// The future is provided a [`Handle`] to the runtime so that it may spawn additional tasks
    /// to be executed concurrently.
    fn block_on<Fut, R>(&self, fut: Fut) -> R
    where
        Fut: Future<Output = R>;

    /// Returns an iterator wrapper around a stream, blocking the current thread for each item.
    fn block_on_stream<'a, S, R>(&self, stream: S) -> Self::BlockingIterator<'a, R>
    where
        S: Stream<Item = R> + Send + 'a,
        R: Send + 'a;
}