async-ringbuf 0.3.6

Async SPSC FIFO ring buffer
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

use crate::{consumer::AsyncConsumer, producer::AsyncProducer};

/// Tranfer data from one ring buffer to another.
///
/// `count` is the number of items to transfer.
/// The number of actually transfered items is returned.
///
/// If `count` is `Some(n)` then exactly `n` items will be transfered on completion
/// except the situation when `src` or `dst` is closed or the future is dropped before completion.
///
/// If `count` is `None` then transfer will be performed until the one or another ring buffer is closed.
///
/// # Cancel safety
///
/// Transfer safely stops if the future is dropped.
pub async fn async_transfer<T, As: AsyncConsumer<Item = T>, Ad: AsyncProducer<Item = T>>(
    src: &mut As,
    dst: &mut Ad,
    count: Option<usize>,
) -> usize {
    let mut actual_count = 0;
    // TODO: Transfer multiple items at once.
    loop {
        if count.as_ref().is_some_and(|n| actual_count == *n) {
            break;
        }
        actual_count += 1;

        match dst
            .push(match src.pop().await {
                Some(item) => item,
                None => break,
            })
            .await
        {
            Ok(()) => (),
            Err(_item) => break,
        };
    }
    actual_count
}