frunk_utils 0.2.7

Utilities for working with frunk.
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
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289

//! Utilities for working with frunk.

use frunk::{
    hlist::{HMappable, HZippable},
    prelude::HList,
    Generic, HCons, HNil, LabelledGeneric,
};

pub use self::cons_list::{ConsList, ConsListT};

pub mod arithmetic_macros;
pub mod cons_list;

/// The Func trait from frunk doesn't take `self` as a parameter to `call` so there isn't an easy way to get context
/// from the surrounding scope. Here we define our own `Poly` wrapper and `Func` trait that does take `self` as a
/// parameter so the caller can include whatever context they need.
pub struct Poly<F>(pub F);

pub trait Func<I> {
    type Output;

    fn call(&mut self, i: I) -> Self::Output;
}

impl<F: Func<I>, I> Func<I> for &mut F {
    type Output = F::Output;

    fn call(&mut self, i: I) -> Self::Output {
        (*self).call(i)
    }
}

impl<F: Func<Head>, Head, Tail: HMappable<Poly<F>>> HMappable<Poly<F>> for HCons<Head, Tail> {
    type Output = HCons<<F as Func<Head>>::Output, <Tail as HMappable<Poly<F>>>::Output>;

    fn map(self, mut mapper: Poly<F>) -> Self::Output {
        let HCons { head, tail } = self;
        HCons {
            head: mapper.0.call(head),
            tail: tail.map(mapper),
        }
    }
}

/// Convenience functions for the caller to map between similarly-shaped types implementing [Generic] without having to
/// explicitly call [Generic::from] and [Generic::into]
pub trait WithGeneric: Generic {
    fn hmap<U: Generic, F>(self, f: F) -> U
    where
        Self::Repr: HMappable<Poly<F>, Output = U::Repr>;

    fn hzip<U: Generic, TU: Generic<Repr = <Self::Repr as HZippable<U::Repr>>::Zipped>>(
        self,
        other: U,
    ) -> TU
    where
        Self::Repr: HZippable<U::Repr>;

    fn hzip_with<
        F,
        U: Generic,
        TU: Generic<Repr = <<Self::Repr as HZippable<U::Repr>>::Zipped as HMappable<Poly<F>>>::Output>,
    >(
        self,
        other: U,
        f: F,
    ) -> TU
    where
        Self::Repr: HZippable<U::Repr>,
        <Self::Repr as HZippable<U::Repr>>::Zipped: HMappable<Poly<F>>;

    fn hzipped_for_each<F, U: Generic>(self, other: U, f: F)
    where
        Self::Repr: HZippable<U::Repr>,
        <Self::Repr as HZippable<U::Repr>>::Zipped: ForEach<F>;

    fn hzip_to_list<F, U: Generic, O>(
        self,
        other: U,
        f: F,
    ) -> ConsList<O, <<Self::Repr as HZippable<U::Repr>>::Zipped as MapToList<F, O>>::Output>
    where
        Self::Repr: HZippable<U::Repr>,
        <Self::Repr as HZippable<U::Repr>>::Zipped: MapToList<F, O>;

    fn map_to_list<F, O>(self, f: F) -> ConsList<O, <Self::Repr as MapToList<F, O>>::Output>
    where
        Self::Repr: MapToList<F, O>;

    fn for_each<F>(self, f: F)
    where
        Self::Repr: ForEach<F>;

    /// Allows getting an iterator over the fields of a struct if they all have the same type
    fn fields_into_iter<U>(self) -> impl Iterator<Item = U>
    where
        Self::Repr: MapToList<Identity, U>;
}

pub struct Identity;

impl<T> Func<T> for Identity {
    type Output = T;

    fn call(&mut self, i: T) -> Self::Output {
        i
    }
}

impl<T: Generic> WithGeneric for T {
    fn hmap<U: Generic, F>(self, f: F) -> U
    where
        Self::Repr: HMappable<Poly<F>, Output = U::Repr>,
    {
        Generic::from(Generic::into(self).map(Poly(f)))
    }

    fn hzip<U: Generic, TU: Generic<Repr = <Self::Repr as HZippable<U::Repr>>::Zipped>>(
        self,
        other: U,
    ) -> TU
    where
        Self::Repr: HZippable<U::Repr>,
    {
        Generic::from(Generic::into(self).zip(Generic::into(other)))
    }

    fn hzip_with<
        F,
        U: Generic,
        TU: Generic<Repr = <<Self::Repr as HZippable<U::Repr>>::Zipped as HMappable<Poly<F>>>::Output>,
    >(
        self,
        other: U,
        f: F,
    ) -> TU
    where
        Self::Repr: HZippable<U::Repr>,
        <Self::Repr as HZippable<U::Repr>>::Zipped: HMappable<Poly<F>>,
    {
        Generic::from(Generic::into(self).zip(Generic::into(other)).map(Poly(f)))
    }

    fn hzipped_for_each<F, U: Generic>(self, other: U, f: F)
    where
        Self::Repr: HZippable<U::Repr>,
        <Self::Repr as HZippable<U::Repr>>::Zipped: ForEach<F>,
    {
        Generic::into(self).zip(Generic::into(other)).for_each(f);
    }

    fn hzip_to_list<F, U: Generic, O>(
        self,
        other: U,
        f: F,
    ) -> ConsList<O, <<Self::Repr as HZippable<U::Repr>>::Zipped as MapToList<F, O>>::Output>
    where
        Self::Repr: HZippable<U::Repr>,
        <Self::Repr as HZippable<U::Repr>>::Zipped: MapToList<F, O>,
    {
        Generic::into(self).zip(Generic::into(other)).map_to_list(f)
    }

    fn map_to_list<F, O>(self, f: F) -> ConsList<O, <Self::Repr as MapToList<F, O>>::Output>
    where
        Self::Repr: MapToList<F, O>,
    {
        Generic::into(self).map_to_list(f)
    }

    fn for_each<F>(self, f: F)
    where
        Self::Repr: ForEach<F>,
    {
        Generic::into(self).for_each(f)
    }

    fn fields_into_iter<U>(self) -> impl Iterator<Item = U>
    where
        Self::Repr: MapToList<Identity, U>,
    {
        self.map_to_list(Identity).into_iter()
    }
}

/// Convenience functions for the caller to map between similarly-shaped types implementing [LabelledGeneric] without
/// having to explicitly call [LabelledGeneric::from] and [LabelledGeneric::into]
pub trait WithLabelledGeneric: LabelledGeneric {
    fn hmap<U: LabelledGeneric, F>(self, f: F) -> U
    where
        Self::Repr: HMappable<Poly<F>, Output = U::Repr>;

    fn hzip<
        U: LabelledGeneric,
        TU: LabelledGeneric<Repr = <Self::Repr as HZippable<U::Repr>>::Zipped>,
    >(
        self,
        other: U,
    ) -> TU
    where
        Self::Repr: HZippable<U::Repr>;

    fn map_to_list<F, U>(self, f: F) -> ConsList<U, <Self::Repr as MapToList<F, U>>::Output>
    where
        Self::Repr: MapToList<F, U>;

    fn for_each<F>(self, f: F)
    where
        Self::Repr: ForEach<F>;
}

impl<T: LabelledGeneric> WithLabelledGeneric for T {
    fn hmap<U: LabelledGeneric, F>(self, f: F) -> U
    where
        Self::Repr: HMappable<Poly<F>, Output = U::Repr>,
    {
        LabelledGeneric::from(LabelledGeneric::into(self).map(Poly(f)))
    }

    fn hzip<
        U: LabelledGeneric,
        TU: LabelledGeneric<Repr = <Self::Repr as HZippable<U::Repr>>::Zipped>,
    >(
        self,
        other: U,
    ) -> TU
    where
        Self::Repr: HZippable<U::Repr>,
    {
        LabelledGeneric::from(LabelledGeneric::into(self).zip(LabelledGeneric::into(other)))
    }

    fn map_to_list<F, U>(self, f: F) -> ConsList<U, <Self::Repr as MapToList<F, U>>::Output>
    where
        Self::Repr: MapToList<F, U>,
    {
        LabelledGeneric::into(self).map_to_list(f)
    }

    fn for_each<F>(self, f: F)
    where
        Self::Repr: ForEach<F>,
    {
        LabelledGeneric::into(self).for_each(f)
    }
}

pub trait MapToList<F, U>: HList {
    type Output: ConsListT<U>;

    /// Map a monomorphizing function over the HList to produce an [iterable](`ConsList::into_iter`) datastructure which
    /// lives fully on stack
    fn map_to_list(self, f: F) -> ConsList<U, Self::Output>;
}

impl<F, U> MapToList<F, U> for HNil {
    type Output = cons_list::Nil;

    fn map_to_list(self, _f: F) -> ConsList<U, Self::Output> {
        ConsList::nil()
    }
}

impl<F: Func<Head, Output = U>, U, Head, Tail: MapToList<F, U>> MapToList<F, U>
    for HCons<Head, Tail>
{
    type Output = cons_list::Cons<U, <Tail as MapToList<F, U>>::Output>;

    fn map_to_list(self, mut f: F) -> ConsList<U, Self::Output> {
        let HCons { head, tail } = self;
        ConsList::cons(f.call(head), tail.map_to_list(f))
    }
}

pub trait ForEach<F>: HList {
    fn for_each(self, f: F);
}

impl<F> ForEach<F> for HNil {
    fn for_each(self, _: F) {}
}

impl<F: Func<Head, Output = ()>, Head, Tail: ForEach<F>> ForEach<F> for HCons<Head, Tail> {
    fn for_each(self, mut f: F) {
        let HCons { head, tail } = self;
        f.call(head);
        tail.for_each(f)
    }
}