symsrv 0.5.6

A Microsoft symsrv symbol server consumer (downloader + cache)
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
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112

use std::future::{poll_fn, Future};
use std::task::Poll;

use futures_util::FutureExt;

/// Provides a way to iterate over a collection of futures, but polling all
/// of them from the start. This can be used to start e.g. network requests
/// in parallel and to consume the results in the original order.
pub struct PollAllPreservingOrder<V, F: Future<Output = V> + Unpin> {
    values: Vec<Option<V>>, // None if pending or already consumed, Some if ready
    pending_futures: Vec<(usize, F)>,
    current_index: usize,
}

impl<V, F: Future<Output = V> + Unpin> PollAllPreservingOrder<V, F> {
    pub fn new(futures: Vec<F>) -> Self {
        Self {
            values: futures.iter().map(|_| None).collect(),
            pending_futures: futures.into_iter().enumerate().collect(),
            current_index: 0,
        }
    }

    pub async fn next(&mut self) -> Option<V> {
        poll_fn(move |cx| {
            if self.current_index == self.values.len() {
                return Poll::Ready(None);
            }

            // Poll all pending futures and remove the ones that are ready,
            // storing their values in the values array.
            self.pending_futures
                .retain_mut(|(i, f)| match f.poll_unpin(cx) {
                    Poll::Pending => true,
                    Poll::Ready(e) => {
                        self.values[*i] = Some(e);
                        false
                    }
                });
            if let Some(next_value) = self.values[self.current_index].take() {
                self.current_index += 1;
                Poll::Ready(Some(next_value))
            } else {
                Poll::Pending
            }
        })
        .await
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use futures_util::future::ready;

    #[tokio::test]
    async fn test_poll_all_ready() {
        let futures = vec![ready(1), ready(2), ready(3), ready(4), ready(5), ready(6)];
        let mut poll_all = PollAllPreservingOrder::new(futures);
        assert_eq!(poll_all.next().await, Some(1));
        assert_eq!(poll_all.next().await, Some(2));
        assert_eq!(poll_all.next().await, Some(3));
        assert_eq!(poll_all.next().await, Some(4));
        assert_eq!(poll_all.next().await, Some(5));
        assert_eq!(poll_all.next().await, Some(6));
        assert_eq!(poll_all.next().await, None);
    }

    #[tokio::test]
    async fn test_poll_some_pending() {
        // We create a tokio channel to send numbers. The channel broadcasts the messages
        // to all receivers. Then we create six receivers. Each receiver has an associated
        // threshold and a value. The receiver will read from the channel until it receives
        // a number which is at least as big as its threshold. Then it will return the value.
        async fn yield_until_threshold_exceeded(
            mut rx: tokio::sync::broadcast::Receiver<i32>,
            threshold: i32,
            value: i32,
        ) -> i32 {
            loop {
                let msg = rx.recv().await.unwrap();
                if msg >= threshold {
                    return value;
                }
                tokio::task::yield_now().await;
            }
        }
        let (tx, _) = tokio::sync::broadcast::channel(100);
        let receivers = vec![
            yield_until_threshold_exceeded(tx.subscribe(), 6, 1),
            yield_until_threshold_exceeded(tx.subscribe(), 3, 2),
            yield_until_threshold_exceeded(tx.subscribe(), 5, 3),
            yield_until_threshold_exceeded(tx.subscribe(), 1, 4),
            yield_until_threshold_exceeded(tx.subscribe(), 2, 5),
            yield_until_threshold_exceeded(tx.subscribe(), 4, 6),
        ];
        // Feed messages into the channel.
        for x in 0..10 {
            tx.send(x).unwrap();
        }
        // Create the poller and check that it returns the values in the correct order.
        let mut poll_all =
            PollAllPreservingOrder::new(receivers.into_iter().map(Box::pin).collect());
        assert_eq!(poll_all.next().await, Some(1));
        assert_eq!(poll_all.next().await, Some(2));
        assert_eq!(poll_all.next().await, Some(3));
        assert_eq!(poll_all.next().await, Some(4));
        assert_eq!(poll_all.next().await, Some(5));
        assert_eq!(poll_all.next().await, Some(6));
        assert_eq!(poll_all.next().await, None);
    }
}