alux-shape 0.3.0

Data shapes as a first-order program, independent of any encoder
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
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
//! How a value is made from the members its shape names, and taken apart into them.
//!
//! A shape describes a value; it never builds one. An interpretation that reads a value member by
//! member, from command-line words, named parameters, or a form, needs the other direction too: a
//! product is its fields taken together, and a sum is the one alternative it carries. A sum is an
//! isomorphism with a `SumN`. A product is one with a tuple unless a member is skipped: that member is
//! no field and is made with `Default`, so a product made from its fields answers those fields, and its members are named as identifiers, the way an
//! operation's argument names are, so `words_of` reads them as the words a shape names them by.

use alux_ext::ext;

/// States that a value is its fields taken together.
///
/// `#[derive(Shape)]` states it for every struct it reads.
#[diagnostic::on_unimplemented(
    message = "`{Self}` is not stated as a product of its fields",
    note = "`#[derive(Shape)]` states `Product` for a struct with named members; a skipped member is made with `Default`, and a flattened one is one field"
)]
pub trait Product: Sized {
    /// The fields, in order, as a tuple.
    type Fields;
    /// The fields' names, in order, as identifiers.
    const FIELDS: &'static [&'static str];

    /// Makes the value from its fields.
    fn from_fields(fields: Self::Fields) -> Self;

    /// Takes the value apart into its fields.
    fn into_fields(self) -> Self::Fields;
}

/// States that a value is exactly one of its alternatives.
///
/// An alternative carrying no value is `()`.
///
/// `#[derive(Shape)]` states it for every enum it reads with two to sixteen alternatives.
#[diagnostic::on_unimplemented(
    message = "`{Self}` is not stated as a sum of its alternatives",
    note = "`#[derive(Shape)]` states `Sum` for an enum of two to sixteen alternatives, each carrying one value or none"
)]
pub trait Sum: Sized {
    /// The alternatives, in order, as a `Sum2` through `Sum16`.
    type Alternatives;
    /// The alternatives' names, in order, as identifiers.
    const ALTERNATIVES: &'static [&'static str];

    /// Makes the value from the alternative it carries.
    fn from_alternative(alternative: Self::Alternatives) -> Self;

    /// Answers the alternative the value carries.
    fn into_alternative(self) -> Self::Alternatives;
}

/// Holds the one alternative of two a value carries.
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash)]
pub enum Sum2<A, B> {
    /// The first alternative.
    A(A),
    /// The second alternative.
    B(B),
}

/// Holds the one alternative of three a value carries.
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash)]
pub enum Sum3<A, B, C> {
    /// The first alternative.
    A(A),
    /// The second alternative.
    B(B),
    /// The third alternative.
    C(C),
}

/// Holds the one alternative of four a value carries.
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash)]
pub enum Sum4<A, B, C, D> {
    /// The first alternative.
    A(A),
    /// The second alternative.
    B(B),
    /// The third alternative.
    C(C),
    /// The fourth alternative.
    D(D),
}

/// Holds the one alternative of five a value carries.
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash)]
pub enum Sum5<A, B, C, D, E> {
    /// The first alternative.
    A(A),
    /// The second alternative.
    B(B),
    /// The third alternative.
    C(C),
    /// The fourth alternative.
    D(D),
    /// The fifth alternative.
    E(E),
}

/// Holds the one alternative of six a value carries.
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash)]
pub enum Sum6<A, B, C, D, E, F> {
    /// The first alternative.
    A(A),
    /// The second alternative.
    B(B),
    /// The third alternative.
    C(C),
    /// The fourth alternative.
    D(D),
    /// The fifth alternative.
    E(E),
    /// The sixth alternative.
    F(F),
}

/// Holds the one alternative of seven a value carries.
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash)]
pub enum Sum7<A, B, C, D, E, F, G> {
    /// The first alternative.
    A(A),
    /// The second alternative.
    B(B),
    /// The third alternative.
    C(C),
    /// The fourth alternative.
    D(D),
    /// The fifth alternative.
    E(E),
    /// The sixth alternative.
    F(F),
    /// The seventh alternative.
    G(G),
}

/// Holds the one alternative of eight a value carries.
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash)]
pub enum Sum8<A, B, C, D, E, F, G, H> {
    /// The first alternative.
    A(A),
    /// The second alternative.
    B(B),
    /// The third alternative.
    C(C),
    /// The fourth alternative.
    D(D),
    /// The fifth alternative.
    E(E),
    /// The sixth alternative.
    F(F),
    /// The seventh alternative.
    G(G),
    /// The eighth alternative.
    H(H),
}

/// Holds the one alternative of nine a value carries.
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash)]
pub enum Sum9<A, B, C, D, E, F, G, H, I> {
    /// The first alternative.
    A(A),
    /// The second alternative.
    B(B),
    /// The third alternative.
    C(C),
    /// The fourth alternative.
    D(D),
    /// The fifth alternative.
    E(E),
    /// The sixth alternative.
    F(F),
    /// The seventh alternative.
    G(G),
    /// The eighth alternative.
    H(H),
    /// The ninth alternative.
    I(I),
}

/// Holds the one alternative of ten a value carries.
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash)]
pub enum Sum10<A, B, C, D, E, F, G, H, I, J> {
    /// The first alternative.
    A(A),
    /// The second alternative.
    B(B),
    /// The third alternative.
    C(C),
    /// The fourth alternative.
    D(D),
    /// The fifth alternative.
    E(E),
    /// The sixth alternative.
    F(F),
    /// The seventh alternative.
    G(G),
    /// The eighth alternative.
    H(H),
    /// The ninth alternative.
    I(I),
    /// The tenth alternative.
    J(J),
}

/// Holds the one alternative of eleven a value carries.
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash)]
pub enum Sum11<A, B, C, D, E, F, G, H, I, J, K> {
    /// The first alternative.
    A(A),
    /// The second alternative.
    B(B),
    /// The third alternative.
    C(C),
    /// The fourth alternative.
    D(D),
    /// The fifth alternative.
    E(E),
    /// The sixth alternative.
    F(F),
    /// The seventh alternative.
    G(G),
    /// The eighth alternative.
    H(H),
    /// The ninth alternative.
    I(I),
    /// The tenth alternative.
    J(J),
    /// The eleventh alternative.
    K(K),
}

/// Holds the one alternative of twelve a value carries.
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash)]
pub enum Sum12<A, B, C, D, E, F, G, H, I, J, K, L> {
    /// The first alternative.
    A(A),
    /// The second alternative.
    B(B),
    /// The third alternative.
    C(C),
    /// The fourth alternative.
    D(D),
    /// The fifth alternative.
    E(E),
    /// The sixth alternative.
    F(F),
    /// The seventh alternative.
    G(G),
    /// The eighth alternative.
    H(H),
    /// The ninth alternative.
    I(I),
    /// The tenth alternative.
    J(J),
    /// The eleventh alternative.
    K(K),
    /// The twelfth alternative.
    L(L),
}

/// Holds the one alternative of thirteen a value carries.
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash)]
pub enum Sum13<A, B, C, D, E, F, G, H, I, J, K, L, M> {
    /// The first alternative.
    A(A),
    /// The second alternative.
    B(B),
    /// The third alternative.
    C(C),
    /// The fourth alternative.
    D(D),
    /// The fifth alternative.
    E(E),
    /// The sixth alternative.
    F(F),
    /// The seventh alternative.
    G(G),
    /// The eighth alternative.
    H(H),
    /// The ninth alternative.
    I(I),
    /// The tenth alternative.
    J(J),
    /// The eleventh alternative.
    K(K),
    /// The twelfth alternative.
    L(L),
    /// The thirteenth alternative.
    M(M),
}

/// Holds the one alternative of fourteen a value carries.
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash)]
pub enum Sum14<A, B, C, D, E, F, G, H, I, J, K, L, M, N> {
    /// The first alternative.
    A(A),
    /// The second alternative.
    B(B),
    /// The third alternative.
    C(C),
    /// The fourth alternative.
    D(D),
    /// The fifth alternative.
    E(E),
    /// The sixth alternative.
    F(F),
    /// The seventh alternative.
    G(G),
    /// The eighth alternative.
    H(H),
    /// The ninth alternative.
    I(I),
    /// The tenth alternative.
    J(J),
    /// The eleventh alternative.
    K(K),
    /// The twelfth alternative.
    L(L),
    /// The thirteenth alternative.
    M(M),
    /// The fourteenth alternative.
    N(N),
}

/// Holds the one alternative of fifteen a value carries.
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash)]
pub enum Sum15<A, B, C, D, E, F, G, H, I, J, K, L, M, N, O> {
    /// The first alternative.
    A(A),
    /// The second alternative.
    B(B),
    /// The third alternative.
    C(C),
    /// The fourth alternative.
    D(D),
    /// The fifth alternative.
    E(E),
    /// The sixth alternative.
    F(F),
    /// The seventh alternative.
    G(G),
    /// The eighth alternative.
    H(H),
    /// The ninth alternative.
    I(I),
    /// The tenth alternative.
    J(J),
    /// The eleventh alternative.
    K(K),
    /// The twelfth alternative.
    L(L),
    /// The thirteenth alternative.
    M(M),
    /// The fourteenth alternative.
    N(N),
    /// The fifteenth alternative.
    O(O),
}

/// Holds the one alternative of sixteen a value carries.
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash)]
pub enum Sum16<A, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P> {
    /// The first alternative.
    A(A),
    /// The second alternative.
    B(B),
    /// The third alternative.
    C(C),
    /// The fourth alternative.
    D(D),
    /// The fifth alternative.
    E(E),
    /// The sixth alternative.
    F(F),
    /// The seventh alternative.
    G(G),
    /// The eighth alternative.
    H(H),
    /// The ninth alternative.
    I(I),
    /// The tenth alternative.
    J(J),
    /// The eleventh alternative.
    K(K),
    /// The twelfth alternative.
    L(L),
    /// The thirteenth alternative.
    M(M),
    /// The fourteenth alternative.
    N(N),
    /// The fifteenth alternative.
    O(O),
    /// The sixteenth alternative.
    P(P),
}

/// States that a product made from its fields answers those fields.
///
/// A skipped member is no field, so the product made again holds its `Default`, not its value.
#[ext(name = ProductLawsExt)]
pub impl<This, Fields> This
where
    This: Product<Fields = Fields> + Clone,
    Fields: Clone + PartialEq,
{
    /// Taking apart a product made from this one's fields answers the same fields.
    fn law_product_round_trip(&self) -> bool {
        let fields = self.clone().into_fields();
        This::from_fields(fields.clone()).into_fields() == fields
    }
}

/// States that answering a sum's alternative and making it again changes nothing.
#[ext(name = SumLawsExt)]
pub impl<This> This
where
    This: Sum + Clone + PartialEq,
{
    /// Making a sum from the alternative it carries answers the same sum.
    fn law_sum_round_trip(&self) -> bool {
        This::from_alternative(self.clone().into_alternative()) == *self
    }
}