event_iterator 0.2.2

Asynchronous lending iterator
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

use core::{
    fmt,
    pin::Pin,
    task::{Context, Poll},
};

use crate::EventIterator;

/// Event iterator that endlessly repeats a single event
///
/// This event iterator is created by the [`repeat()`] function.  See its
/// documentation for more.
pub struct Repeat<E>(E);

impl<E> fmt::Debug for Repeat<E>
where
    E: fmt::Debug,
{
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        f.debug_tuple("Repeat").field(&self.0).finish()
    }
}

impl<E> EventIterator for Repeat<E>
where
    E: Clone,
{
    type Event<'me> = E where Self: 'me;

    fn poll_next<'a>(
        self: Pin<&'a Self>,
        _cx: &mut Context<'_>,
    ) -> Poll<Option<Self::Event<'a>>> {
        Poll::Ready(Some(self.0.clone()))
    }

    fn size_hint(&self) -> (usize, Option<usize>) {
        (usize::MAX, None)
    }
}

/// Create an event iterator that endlessly repeats a single event.
///
/// # Example
///
/// ```rust
#[doc = include_str!("../examples/repeat.rs")]
/// ```
pub fn repeat<E>(event: E) -> Repeat<E>
where
    E: Clone,
{
    Repeat(event)
}