frayed 0.1.0

Unfused and unashamed iterators
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

#![doc(html_root_url = "https://docs.rs/frayed/0.1.0")]
#![doc = include_str!("../README.md")]
pub mod fraught;
pub mod defray;
pub use defray::Defray;
use fraught::prefix::Prefix;

/// Marker trait
pub trait Frayed: Iterator {}

/// Adapter struct
pub struct FrayedIter<I: Iterator> {
    pub unfused: I,
}

/// Frayed tools only operate on iterators marked as `Frayed`.
pub trait FrayedTools: Frayed {
    /// Turn a frayed iterator into an iterator of iterator, that is, de-fray
    /// it.
    fn defray(self) -> Defray<Self>
    where
        Self: Sized,
    {
        Defray::new(self)
    }
}

impl<T> FrayedTools for T where T: Frayed + ?Sized {}

/// Fraught tools operate on regular iterators but may accept or return `Frayed`
/// iterators.
pub trait FraughtTools: Iterator {
    /// Use this iterator as a prefix for a frayed iterator with many postfixes.
    fn prefix<I>(self, postfixes: I) -> Prefix<Self, I>
    where
        I: Frayed<Item = Self::Item>,
        Self: Sized + Clone,
    {
        Prefix::new(self, postfixes)
    }

    /// Mark this iterator as `Frayed`. Can then use the `FrayedTools` extension
    /// methods.
    fn frayed(self) -> FrayedIter<Self>
    where
        Self: Sized,
    {
        FrayedIter { unfused: self }
    }
}

impl<T> FraughtTools for T where T: Iterator + ?Sized {}

impl<I: Iterator> Iterator for FrayedIter<I> {
    type Item = I::Item;
    #[inline(always)]
    fn next(&mut self) -> Option<Self::Item> {
        self.unfused.next()
    }
}

impl<I: Iterator> Frayed for FrayedIter<I> {}

// #[cfg(test)]
// mod tests {
//     use super::*;

//     #[test]
//     fn it_works() {
//     }
// }