qbice 0.6.4

The Query-Based Incremental Computation Engine
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

use std::sync::atomic::AtomicUsize;

pub struct EveryNQueryYielder {
    counter: AtomicUsize,
    n: usize,
}

impl EveryNQueryYielder {
    /// Creates a new `EveryNQueryYielder` that will yield to the async runtime
    /// every `n + 1` queries.
    pub const fn new(n: usize) -> Self {
        Self { counter: AtomicUsize::new(0), n: n + 1 }
    }

    /// Checks if the engine should yield to the async runtime based on the
    /// number of queries executed since the last yield.
    pub async fn tick(&self) {
        let count =
            self.counter.fetch_add(1, std::sync::atomic::Ordering::Relaxed);

        if count.is_multiple_of(self.n) {
            // Yield to the async runtime to allow other tasks to make progress.
            tokio::task::yield_now().await;
        }
    }
}

pub enum Yielder {
    Never,
    EveryNQuery(EveryNQueryYielder),
}

impl Yielder {
    /// Creates a new `Yielder` that will yield to the async runtime every `n`
    /// queries.
    pub const fn every_n_query(n: usize) -> Self {
        Self::EveryNQuery(EveryNQueryYielder::new(n))
    }

    /// Creates a new `Yielder` that will never yield to the async runtime.
    pub const fn never() -> Self { Self::Never }

    /// Checks if the engine should yield to the async runtime based on the
    /// configured yielding strategy.
    pub async fn tick(&self) {
        match self {
            Self::Never => {}
            Self::EveryNQuery(yielder) => yielder.tick().await,
        }
    }
}