hlist2 0.0.15

Compile-time heterogeneous list implementation
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
113
114
115
116
117
118
119

use crate::{Cons, HList, Nil};

use super::{FoldFn, Folder};

/// Fold every element of the heterogenous list into an accumulator.
pub trait Fold<Accumulator, Folder>: HList {
    /// Folds every element into an accumulator
    /// by applying an operation via folder, returning the final result.
    ///
    /// This left folds the heterogenous list from its beginning to the end,
    /// or combines elements in a *left-associative* fashion.
    /// For a *right-associative* version of `fold()`, see [`RFold::rfold()`][rfold].
    ///
    /// [rfold]: crate::ops::RFold::rfold()
    ///
    /// # Examples
    ///
    /// You can fold the list if it is homogenous (all elements have the same type):
    ///
    /// ```
    /// use hlist2::{hlist, ops::Fold};
    ///
    /// let list = hlist![1, 2, 3];
    /// let sum = list.fold(0, |acc, x| acc + x);
    /// assert_eq!(sum, 6);
    /// ```
    ///
    /// Folding of heterogenous list is possible with heterogenous list of closures as folder:
    ///
    /// ```
    /// use hlist2::{hlist, ops::Fold};
    ///
    /// let list = hlist![1, false, 42.0];
    /// let folded = list.fold(
    ///     1.0,
    ///     hlist![
    ///         |acc, i| i as f32 + acc,
    ///         |acc, b: bool| if !b && acc > 42.0 { 9000.0 } else { 0.0 },
    ///         |acc, f| f + acc,
    ///     ],
    /// );
    /// assert_eq!(folded, 42.0);
    /// ```
    ///
    /// Or with special implementation of [folder function](FoldFn):
    ///
    /// ```
    /// use hlist2::{
    ///     hlist,
    ///     ops::{Fold, FoldFn, Folder},
    /// };
    ///
    /// struct MyFoldFn;
    ///
    /// impl FoldFn<f32, i32> for MyFoldFn {
    ///     fn fold(&mut self, acc: f32, i: i32) -> f32 {
    ///         i as f32 + acc
    ///     }
    /// }
    /// impl FoldFn<f32, bool> for MyFoldFn {
    ///     fn fold(&mut self, acc: f32, b: bool) -> f32 {
    ///         if !b && acc > 42.0 { 9000.0 } else { 0.0 }
    ///     }
    /// }
    /// impl FoldFn<f32, f32> for MyFoldFn {
    ///     fn fold(&mut self, acc: f32, f: f32) -> f32 {
    ///         f + acc
    ///     }
    /// }
    ///
    /// let list = hlist![1, false, 42.0];
    /// let folded = list.fold(8918.0, Folder(MyFoldFn));
    /// assert_eq!(folded, 9042.0);
    /// ```
    fn fold(self, init: Accumulator, folder: Folder) -> Accumulator;
}

impl<A, F> Fold<A, F> for Nil {
    fn fold(self, init: A, _: F) -> A {
        init
    }
}

impl<A, F, Head, Tail> Fold<A, F> for Cons<Head, Tail>
where
    F: FnMut(A, Head) -> A,
    Tail: Fold<A, F>,
{
    fn fold(self, init: A, mut folder: F) -> A {
        let Cons(head, tail) = self;
        let init = folder(init, head);
        tail.fold(init, folder)
    }
}

impl<A, FHead, FTail, Head, Tail> Fold<A, Cons<FHead, FTail>> for Cons<Head, Tail>
where
    FHead: FnOnce(A, Head) -> A,
    Tail: Fold<A, FTail>,
{
    fn fold(self, init: A, folder: Cons<FHead, FTail>) -> A {
        let Cons(head, tail) = self;
        let Cons(folder_head, folder_tail) = folder;
        let init = folder_head(init, head);
        tail.fold(init, folder_tail)
    }
}

impl<A, F, Head, Tail> Fold<A, Folder<F>> for Cons<Head, Tail>
where
    F: FoldFn<A, Head>,
    Tail: Fold<A, Folder<F>>,
{
    fn fold(self, init: A, mut folder: Folder<F>) -> A {
        let Cons(head, tail) = self;
        let init = folder.fold(init, head);
        tail.fold(init, folder)
    }
}