commonware-runtime 2026.4.0

Execute asynchronous tasks with a configurable scheduler.
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
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65

//! Implements a [criterion]-compatible executor for the [tokio] runtime.

use super::context;
use crate::{tokio, Runner as _};
use criterion::async_executor::AsyncExecutor;
use futures::Future;

/// A [criterion]-compatible executor for the [tokio] runtime.
///
/// # Example
///
/// ```rust
/// use criterion::{criterion_group, criterion_main, Criterion, BatchSize};
/// use commonware_runtime::{Clock, benchmarks::{context, tokio}};
/// use std::time::Duration;
///
/// fn my_benchmark(c: &mut Criterion) {
///     let executor = tokio::Runner::default();
///     c.bench_function("sleep_benchmark", |b| {
///         b.to_async(&executor).iter_batched(|| (),
///         |_| async {
///             // Get the context
///             let ctx = context::get::<commonware_runtime::tokio::Context>();
///             // Use context features
///             ctx.sleep(Duration::from_micros(10)).await;
///         }, BatchSize::SmallInput);
///     });
/// }
/// ```
#[derive(Clone)]
pub struct Runner {
    cfg: tokio::Config,
}

impl Runner {
    /// Create a new bencher with the given configuration
    pub const fn new(cfg: tokio::Config) -> Self {
        Self { cfg }
    }
}

impl Default for Runner {
    fn default() -> Self {
        Self::new(tokio::Config::default())
    }
}

impl AsyncExecutor for &Runner {
    fn block_on<T>(&self, future: impl Future<Output = T>) -> T {
        let runner = tokio::Runner::new(self.cfg.clone());

        let result = runner.start(|ctx| {
            // Create and store our context
            context::set(ctx);

            // Run the future
            future
        });

        // Clean up
        context::clear();

        result
    }
}