wireshift-core 0.1.1

Core typed operations, buffers, and backend traits for wireshift
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

//! A First-In-First-Out (FIFO) queue for simple job strategy processing.
use crate::completion::CompletionEvent;
use crate::error::Result;
use crate::{BackendFactory, Ring};

/// Drains one completion at a time in submission order.
///
/// ```no_run
/// use wireshift::{Ring, RingConfig, strategy::FifoDrain};
///
/// let ring = Ring::new(RingConfig::default())?;
/// let drain = FifoDrain::new(ring);
/// let _ = drain;
/// # Ok::<(), Box<dyn std::error::Error>>(())
/// ```
#[derive(Clone)]
pub struct FifoDrain<F: BackendFactory> {
    ring: Ring<F>,
}

impl<F: BackendFactory> FifoDrain<F> {
    /// Creates a FIFO drain adapter.
    #[must_use]
    pub fn new(ring: Ring<F>) -> Self {
        Self { ring }
    }

    /// Waits for one completion.
    pub fn next(&self) -> Result<CompletionEvent> {
        self.ring.complete(None)
    }
}