mutatis 0.5.2

`mutatis` is a library for writing custom, structure-aware test-case mutators for fuzzers in Rust.
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
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
use super::*;
use crate::Result;
use core::{cmp, ops};

mod atomic;
mod cell;
mod duration;
mod non_zero;
mod option;
mod phantom;
mod ranges;
mod ref_cell;
mod result;
mod reverse;
mod unsafe_cell;
mod wrapping;
pub use atomic::*;
pub use cell::*;
pub use duration::*;
pub use non_zero::*;
pub use option::*;
pub use phantom::*;
pub use ranges::*;
pub use ref_cell::*;
pub use result::*;
pub use reverse::*;
pub use unsafe_cell::*;
pub use wrapping::*;

/// The default mutator for `bool` values.
///
/// See the [`bool()`] function to create new instances and for example usage.
#[derive(Clone, Debug, Default)]
pub struct Bool {
    _private: (),
}

/// Create a new `bool` mutator.
///
/// # Example
///
/// ```
/// use mutatis::{mutators as m, Mutate, Session};
///
/// let mut mutator = m::bool();
/// let mut session = Session::new();
///
/// let mut value = true;
/// session.mutate_with(&mut mutator, &mut value).unwrap();
///
/// assert_eq!(value, false);
/// ```
pub fn bool() -> Bool {
    Bool { _private: () }
}

impl Mutate<bool> for Bool {
    #[inline]
    fn mutate(&mut self, c: &mut Candidates, value: &mut bool) -> Result<()> {
        if !c.shrink() || *value {
            c.mutation(|_ctx| Ok(*value = !*value))?;
        }
        Ok(())
    }

    #[inline]
    fn mutation_count(&self, value: &bool, shrink: bool) -> core::option::Option<u32> {
        Some(if !shrink || *value { 1 } else { 0 })
    }
}

impl Generate<bool> for Bool {
    #[inline]
    fn generate(&mut self, ctx: &mut Context) -> Result<bool> {
        Ok(ctx.rng().gen_bool())
    }
}

impl DefaultMutate for bool {
    type DefaultMutate = Bool;
}

macro_rules! ints {
    (
        $(
            $fn_name:ident -> $ty_name:ident : $method:ident for $ty:ty ;
        )*
    ) => {
        $(
            /// A mutator for
            #[doc = concat!("`", stringify!($fn_name), "`")]
            /// values.
            ///
            /// See the
            #[doc = concat!("[`", stringify!($fn_name), "()`]")]
            /// function to create new instances and for
            /// example usage.
            #[derive(Clone, Debug, Default)]
            pub struct $ty_name {
                _private: (),
            }

            /// Create a new
            #[doc = concat!("`", stringify!($ty), "`")]
            /// mutator.
            ///
            /// # Example
            ///
            /// ```
            /// use mutatis::{mutators as m, Mutate, Session};
            ///
            #[doc = concat!("let mut mutator = m::", stringify!($fn_name), "();")]
            ///
            /// let mut session = Session::new().shrink(true);
            ///
            /// let mut value = 42;
            /// session.mutate_with(&mut mutator, &mut value).unwrap();
            ///
            /// assert!(value < 42);
            /// ```
            pub fn $fn_name() -> $ty_name {
                $ty_name { _private: () }
            }

            impl Mutate<$ty> for $ty_name {
                #[inline]
                fn mutate(&mut self, c: &mut Candidates, value: &mut $ty) -> Result<()> {
                    if c.shrink() && *value == 0 {
                        return Ok(());
                    }
                    c.mutation(|ctx| {
                        *value = if ctx.shrink() {
                            ctx.rng().inner().gen_range(0..*value)
                        } else {
                            ctx.rng().$method()
                        };
                        Ok(())
                    })
                }

                #[inline]
                fn mutation_count(&self, value: &$ty, shrink: bool) -> core::option::Option<u32> {
                    Some(if shrink && *value == 0 { 0 } else { 1 })
                }
            }

            impl DefaultMutate for $ty {
                type DefaultMutate = $ty_name;
            }

            impl Generate<$ty> for $ty_name {
                #[inline]
                fn generate(&mut self, ctx: &mut Context) -> Result<$ty> {
                    Ok(ctx.rng().$method())
                }
            }

            impl MutateInRange<$ty> for $ty_name {
                #[inline]
                fn mutate_in_range(
                    &mut self,
                    c: &mut Candidates,
                    value: &mut $ty,
                    range: &ops::RangeInclusive<$ty>,
                ) -> Result<()> {
                    let start = *range.start();
                    let end = *range.end();

                    if start > end {
                        return Err(Error::invalid_range());
                    }

                    if *value == start && c.shrink() {
                        return Ok(());
                    }

                    c.mutation(|ctx| {
                        let end = if ctx.shrink() {
                            cmp::min(*value, end)
                        } else {
                            end
                        };

                        *value = ctx.rng().inner().gen_range(start..=end);
                        Ok(())
                    })
                }
            }
        )*
    };
}

ints! {
    u8 -> U8 : gen_u8 for u8;
    u16 -> U16 : gen_u16 for u16;
    u32 -> U32 : gen_u32 for u32;
    u64 -> U64 : gen_u64 for u64;
    u128 -> U128 : gen_u128 for u128;
    usize -> Usize : gen_usize for usize;
    i8 -> I8 : gen_i8 for i8;
    i16 -> I16 : gen_i16 for i16;
    i32 -> I32 : gen_i32 for i32;
    i64 -> I64 : gen_i64 for i64;
    i128 -> I128 : gen_i128 for i128;
    isize -> Isize : gen_isize for isize;
}

/// A mutator for `char` values.
///
/// See the [`char()`] function to create new instances and for example usage.
#[derive(Clone, Debug, Default)]
pub struct Char {
    _private: (),
}

/// Create a mutator for `char` values.
///
/// # Example
///
/// ```
/// # fn foo() -> mutatis::Result<()> {
/// use mutatis::{mutators as m, Mutate, Session};
///
/// let mut mutator = m::char();
/// let mut session = Session::new();
///
/// let mut c = 'a';
/// for _ in 0..5 {
///     session.mutate_with(&mut mutator, &mut c)?;
///     println!("mutated c is {c}");
/// }
///
/// // Example output:
/// //
/// //     mutated c is !
/// //     mutated c is ᐠ
/// //     mutated c is 𬸚
/// //     mutated c is 1
/// //     mutated c is 꼜
/// # Ok(())
/// # }
/// # foo().unwrap();
/// ```
pub fn char() -> Char {
    Char { _private: () }
}

impl Mutate<char> for Char {
    #[inline]
    fn mutation_count(&self, value: &char, shrink: bool) -> core::option::Option<u32> {
        Some(if shrink { (*value != '\0') as u32 } else { 8 })
    }

    #[inline]
    fn mutate(&mut self, c: &mut Candidates, value: &mut char) -> Result<()> {
        if c.shrink() {
            if *value != '\0' {
                c.mutation(|ctx| {
                    *value = ctx.rng().inner().gen_range('\0'..*value);
                    Ok(())
                })?;
            }
            Ok(())
        } else {
            // Choose between one of a few different mutation strategies to bias
            // the distribution towards interesting characters.
            //
            // See https://en.wikipedia.org/wiki/Plane_(Unicode)#Overview and
            // https://en.wikipedia.org/wiki/Unicode_block#List_of_blocks
            //
            // Note that the ranges below still contain some unassigned
            // characters. This is fine. Explicitly listing only assigned
            // characters is too much work, and this is just a best effort kind
            // of thing.

            let ch = |x| char::from_u32(x).unwrap_or_else(|| panic!("invalid char: {x:#x}"));
            let mut char_range = |start, end| mrange(ch(start)..=ch(end)).mutate(c, value);

            // Non-control ASCII characters.
            char_range(0x20, 0x7E)?;

            // Plane 0
            char_range(0x0000, 0xFFFF)?;

            // Plane 1
            char_range(0x10000, 0x14FFF)?;
            // Unassigned: 0x15000..=15FFF.
            char_range(0x16000, 0x18FFF)?;
            // Unassigned: 0x19000..=1AFFF.
            char_range(0x1A000, 0x1FFFF)?;

            // Plane 2
            char_range(0x20000, 0x2FFFF)?;

            // Plane 3
            char_range(0x30000, 0x32FFF)?;

            // Catch all: any valid character, regardless of its plane, block,
            // or if it has been assigned or not.
            c.mutation(|ctx| Ok(*value = ctx.rng().inner().r#gen()))?;

            Ok(())
        }
    }
}

impl DefaultMutate for char {
    type DefaultMutate = Char;
}

impl Generate<char> for Char {
    #[inline]
    fn generate(&mut self, ctx: &mut Context) -> Result<char> {
        Ok(ctx.rng().inner().r#gen())
    }
}

impl MutateInRange<char> for Char {
    #[inline]
    fn mutate_in_range(
        &mut self,
        c: &mut Candidates,
        value: &mut char,
        range: &ops::RangeInclusive<char>,
    ) -> Result<()> {
        let start = *range.start();
        let end = *range.end();

        if start > end {
            return Err(Error::invalid_range());
        }

        if *value == start && c.shrink() {
            return Ok(());
        }

        c.mutation(|ctx| {
            let end = if ctx.shrink() {
                core::cmp::min(*value, end)
            } else {
                end
            };
            *value = ctx.rng().inner().gen_range(start..=end);
            Ok(())
        })
    }
}

/// A mutator for ASCII `char` values.
///
/// See the [`char()`] function to create new instances and for example usage.
#[derive(Clone, Debug, Default)]
pub struct AsciiChar {
    _private: (),
}

/// Create a mutator for ASCII `char` values.
///
/// # Example
///
/// ```
/// # fn foo() -> mutatis::Result<()> {
/// use mutatis::{mutators as m, Mutate, Session};
///
/// let mut mutator = m::ascii_char();
/// let mut session = Session::new();
///
/// let mut c = 'a';
/// for _ in 0..5 {
///     session.mutate_with(&mut mutator, &mut c)?;
///     println!("mutated c is {c}");
/// }
///
/// // Example output:
/// //
/// //     mutated c is J
/// //     mutated c is g
/// //     mutated c is ~
/// //     mutated c is L
/// //     mutated c is v
/// # Ok(())
/// # }
/// # foo().unwrap();
/// ```
pub fn ascii_char() -> AsciiChar {
    AsciiChar { _private: () }
}

impl Mutate<char> for AsciiChar {
    #[inline]
    fn mutation_count(&self, value: &char, shrink: bool) -> core::option::Option<u32> {
        Some(if shrink { (*value != '\0') as u32 } else { 1 })
    }

    #[inline]
    fn mutate(&mut self, c: &mut Candidates, value: &mut char) -> Result<()> {
        if c.shrink() {
            if *value != '\0' {
                c.mutation(|ctx| {
                    *value = ctx.rng().inner().gen_range('\0'..*value);
                    Ok(())
                })?;
            }
            Ok(())
        } else {
            let ch = |x| char::from_u32(x).unwrap_or_else(|| panic!("invalid char: {x:#x}"));
            let mut char_range = |start, end| mrange(ch(start)..=ch(end)).mutate(c, value);

            char_range(0x00, 0x7F)?;

            Ok(())
        }
    }
}

impl Generate<char> for AsciiChar {
    #[inline]
    fn generate(&mut self, ctx: &mut Context) -> Result<char> {
        self.generate_via_mutate(ctx, 1)
    }
}

/// A mutator for `f32` values.
///
/// See the [`f32()`] function to create new instances and for example usage.
#[derive(Default)]
pub struct F32 {
    _private: (),
}

/// Create a mutator for `f32` values.
///
/// # Example
///
/// ```
/// # fn foo() -> mutatis::Result<()> {
/// use mutatis::{mutators as m, Mutate, Session};
///
/// let mut mutator = m::f32();
/// let mut session = Session::new();
///
/// let mut value = 3.14;
/// for _ in 0..5 {
///     session.mutate_with(&mut mutator, &mut value)?;
///     println!("mutated value is {value}");
/// }
///
/// // Example output:
/// //
/// //     mutated value is NaN
/// //     mutated value is -inf
/// //     mutated value is 0.00000011920929
/// //     mutated value is -260030670000000000000000000000000000000
/// //     mutated value is 57951606000000000000000000000000000000
/// # Ok(())
/// # }
/// # foo().unwrap();
/// ```
pub fn f32() -> F32 {
    F32 { _private: () }
}

impl Mutate<f32> for F32 {
    #[inline]
    fn mutation_count(&self, value: &f32, shrink: bool) -> core::option::Option<u32> {
        Some(if shrink {
            if *value == 0.0 {
                0
            } else if value.is_nan() || value.is_infinite() {
                9
            } else {
                1
            }
        } else {
            12
        })
    }

    #[inline]
    fn mutate(&mut self, c: &mut Candidates, value: &mut f32) -> Result<()> {
        let special_finite = |c: &mut Candidates, value: &mut f32| -> Result<()> {
            c.mutation(|_| Ok(*value = 0.0))?;
            c.mutation(|_| Ok(*value = 1.0))?;
            c.mutation(|_| Ok(*value = -1.0))?;
            c.mutation(|_| Ok(*value = f32::EPSILON))?;
            c.mutation(|_| Ok(*value = f32::MIN_POSITIVE))?;
            c.mutation(|_| Ok(*value = f32::MAX))?;
            c.mutation(|_| Ok(*value = f32::MIN))?;
            Ok(())
        };

        let finite = |c: &mut Candidates, value: &mut f32| -> Result<()> {
            special_finite(c, value)?;

            // Positives.
            c.mutation(|ctx| Ok(*value = ctx.rng().inner().r#gen::<f32>() * f32::MAX))?;

            // Negatives.
            c.mutation(|ctx| Ok(*value = ctx.rng().inner().r#gen::<f32>() * f32::MIN))?;

            Ok(())
        };

        if c.shrink() {
            if *value == 0.0 {
                return Ok(());
            }
            if value.is_nan() || value.is_infinite() {
                return finite(c, value);
            }
            c.mutation(|ctx| Ok(*value *= ctx.rng().inner().r#gen::<f32>()))?;
            Ok(())
        } else {
            finite(c, value)?;
            c.mutation(|_| Ok(*value = f32::INFINITY))?;
            c.mutation(|_| Ok(*value = f32::NEG_INFINITY))?;
            c.mutation(|_| Ok(*value = f32::NAN))?;
            Ok(())
        }
    }
}

impl Generate<f32> for F32 {
    #[inline]
    fn generate(&mut self, ctx: &mut Context) -> Result<f32> {
        Ok(ctx.rng().inner().r#gen::<f32>() * f32::MAX)
    }
}

impl DefaultMutate for f32 {
    type DefaultMutate = F32;
}

/// A mutator for `f64` values.
///
/// See the [`f64()`] function to create new instances and for example usage.
#[derive(Default)]
pub struct F64 {
    _private: (),
}

/// Create a mutator for `f64` values.
///
/// # Example
///
/// ```
/// # fn foo() -> mutatis::Result<()> {
/// use mutatis::{mutators as m, Mutate, Session};
///
/// let mut mutator = m::f64();
/// let mut session = Session::new();
///
/// let mut value = 3.14;
/// for _ in 0..5 {
///     session.mutate_with(&mut mutator, &mut value)?;
///     println!("mutated value is {value}");
/// }
///
/// // Example output:
/// //
/// //     mutated value is 0.000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000022250738585072014
/// //     mutated value is 30615525916172793000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000
/// //     mutated value is -inf
/// //     mutated value is -179769313486231570000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000
/// //     mutated value is NaN
/// # Ok(())
/// # }
/// # foo().unwrap();
/// ```
pub fn f64() -> F64 {
    F64 { _private: () }
}

impl Mutate<f64> for F64 {
    #[inline]
    fn mutation_count(&self, value: &f64, shrink: bool) -> core::option::Option<u32> {
        Some(if shrink {
            if *value == 0.0 {
                0
            } else if value.is_nan() || value.is_infinite() {
                9
            } else {
                1
            }
        } else {
            12
        })
    }

    #[inline]
    fn mutate(&mut self, c: &mut Candidates, value: &mut f64) -> Result<()> {
        let special_finite = |c: &mut Candidates, value: &mut f64| -> Result<()> {
            c.mutation(|_| Ok(*value = 0.0))?;
            c.mutation(|_| Ok(*value = 1.0))?;
            c.mutation(|_| Ok(*value = -1.0))?;
            c.mutation(|_| Ok(*value = f64::EPSILON))?;
            c.mutation(|_| Ok(*value = f64::MIN_POSITIVE))?;
            c.mutation(|_| Ok(*value = f64::MAX))?;
            c.mutation(|_| Ok(*value = f64::MIN))?;
            Ok(())
        };

        let finite = |c: &mut Candidates, value: &mut f64| -> Result<()> {
            special_finite(c, value)?;

            // Positives.
            c.mutation(|ctx| Ok(*value = ctx.rng().inner().r#gen::<f64>() * f64::MAX))?;

            // Negatives.
            c.mutation(|ctx| Ok(*value = ctx.rng().inner().r#gen::<f64>() * f64::MIN))?;

            Ok(())
        };

        if c.shrink() {
            if *value == 0.0 {
                return Ok(());
            }
            if value.is_nan() || value.is_infinite() {
                return finite(c, value);
            }
            c.mutation(|ctx| Ok(*value *= ctx.rng().inner().r#gen::<f64>()))?;
            Ok(())
        } else {
            finite(c, value)?;
            c.mutation(|_| Ok(*value = f64::INFINITY))?;
            c.mutation(|_| Ok(*value = f64::NEG_INFINITY))?;
            c.mutation(|_| Ok(*value = f64::NAN))?;
            Ok(())
        }
    }
}

impl Generate<f64> for F64 {
    #[inline]
    fn generate(&mut self, ctx: &mut Context) -> Result<f64> {
        Ok(ctx.rng().inner().r#gen::<f64>() * f64::MAX)
    }
}

impl DefaultMutate for f64 {
    type DefaultMutate = F64;
}

macro_rules! tuples {
    ( $( $fn_name:ident -> $ty_name:ident ( $( $m:ident : $t:ident , )* ) ; )* ) => {
        $(
            /// A mutator for tuples.
            #[derive(Clone, Debug, Default)]
            #[allow(non_snake_case)]
            pub struct $ty_name<$( $m , )*> {
                $(
                    $m: $m,
                )*
            }

            /// Create a new mutator for a tuple of
            #[doc = stringify!(tuples!(@count $( $m )*))]
            /// elements.
            ///
            /// # Example
            ///
            /// ```
            /// # fn _foo() -> mutatis::Result<()> {
            /// use mutatis::{mutators as m, Mutate, Session};
            ///
            /// let mut mutator = m::tuple2(m::u8(), m::i16());
            /// let mut session = Session::new();
            ///
            /// let mut value = (42, -1234);
            /// session.mutate_with(&mut mutator, &mut value)?;
            ///
            /// println!("mutated value is {value:?}");
            /// # Ok(())
            /// # }
            /// ```
            #[allow(non_snake_case)]
            pub fn $fn_name< $( $m ),* >( $( $m: $m ),* ) -> $ty_name<$( $m , )*> {
                $ty_name {
                    $(
                        $m,
                    )*
                }
            }

            #[allow(non_snake_case)]
            impl< $( $m , $t, )* > Mutate<( $( $t , )* )> for $ty_name<$( $m , )*>
            where
                $(
                    $m: Mutate<$t>,
                )*
            {
                #[inline]
                fn mutate(
                    &mut self,
                    _c: &mut Candidates,
                    ( $( $t , )* ): &mut ( $( $t , )* ),
                ) -> Result<()> {
                    $(
                        self.$m.mutate(_c, $t)?;
                    )*
                    Ok(())
                }

                #[inline]
                fn mutation_count(
                    &self,
                    ( $( $t , )* ): &( $( $t , )* ),
                    _shrink: bool,
                ) -> core::option::Option<u32> {
                    Some(0 $( + self.$m.mutation_count($t, _shrink)? )*)
                }
            }

            #[allow(non_snake_case)]
            impl< $( $m , $t, )* > Generate<( $( $t , )* )> for $ty_name<$( $m , )*>
            where
                $(
                    $m: Generate<$t>,
                )*
            {
                #[inline]
                fn generate(&mut self, _ctx: &mut Context) -> Result<( $( $t , )* )> {
                    Ok(( $( self.$m.generate(_ctx)? , )* ))
                }
            }

            #[allow(non_snake_case)]
            impl< $( $t , )* > DefaultMutate for ( $( $t , )* )
            where
                $(
                    $t: DefaultMutate,
                )*
            {
                type DefaultMutate = $ty_name<$( $t::DefaultMutate , )*>;
            }
        )*
    };

    (@count) => { 0 };
    (@count $head:ident $( $rest:ident )*) => { 1 + tuples!(@count $( $rest )*) };
}

tuples! {
    tuple1 -> Tuple1(M0: T0,);
    tuple2 -> Tuple2(M0: T0, M1: T1,);
    tuple3 -> Tuple3(M0: T0, M1: T1, M2: T2,);
    tuple4 -> Tuple4(M0: T0, M1: T1, M2: T2, M3: T3,);
    tuple5 -> Tuple5(M0: T0, M1: T1, M2: T2, M3: T3, M4: T4,);
    tuple6 -> Tuple6(M0: T0, M1: T1, M2: T2, M3: T3, M4: T4, M5: T5,);
    tuple7 -> Tuple7(M0: T0, M1: T1, M2: T2, M3: T3, M4: T4, M5: T5, M6: T6,);
    tuple8 -> Tuple8(M0: T0, M1: T1, M2: T2, M3: T3, M4: T4, M5: T5, M6: T6, M7: T7,);
    tuple9 -> Tuple9(M0: T0, M1: T1, M2: T2, M3: T3, M4: T4, M5: T5, M6: T6, M7: T7, M8: T8,);
    tuple10 -> Tuple10(M0: T0, M1: T1, M2: T2, M3: T3, M4: T4, M5: T5, M6: T6, M7: T7, M8: T8, M9: T9,);
    tuple11 -> Tuple11(M0: T0, M1: T1, M2: T2, M3: T3, M4: T4, M5: T5, M6: T6, M7: T7, M8: T8, M9: T9, M10: T10,);
    tuple12 -> Tuple12(M0: T0, M1: T1, M2: T2, M3: T3, M4: T4, M5: T5, M6: T6, M7: T7, M8: T8, M9: T9, M10: T10, M11: T11,);
    tuple13 -> Tuple13(M0: T0, M1: T1, M2: T2, M3: T3, M4: T4, M5: T5, M6: T6, M7: T7, M8: T8, M9: T9, M10: T10, M11: T11, M12: T12,);
    tuple14 -> Tuple14(M0: T0, M1: T1, M2: T2, M3: T3, M4: T4, M5: T5, M6: T6, M7: T7, M8: T8, M9: T9, M10: T10, M11: T11, M12: T12, M13: T13,);
    tuple15 -> Tuple15(M0: T0, M1: T1, M2: T2, M3: T3, M4: T4, M5: T5, M6: T6, M7: T7, M8: T8, M9: T9, M10: T10, M11: T11, M12: T12, M13: T13, M14: T14,);
    tuple16 -> Tuple16(M0: T0, M1: T1, M2: T2, M3: T3, M4: T4, M5: T5, M6: T6, M7: T7, M8: T8, M9: T9, M10: T10, M11: T11, M12: T12, M13: T13, M14: T14, M15: T15,);
}

/// A unit mutator.
#[derive(Clone, Debug, Default)]
pub struct Unit {
    _private: (),
}

/// Create a new unit (a.k.a zero-element tuple) mutator.
///
/// # Example
///
/// ```
/// use mutatis::{mutators as m, Error, Mutate, Session};
///
/// let mut mutator = m::unit();
/// let mut session = Session::new();
///
/// let mut value = ();
/// let err = session.mutate_with(&mut mutator, &mut value).unwrap_err();
///
/// // Because there is only one possible value for the unit type, the mutator
/// // is always exhausted.
/// assert!(err.is_exhausted());
/// ```
pub fn unit() -> Unit {
    Unit { _private: () }
}

impl Mutate<()> for Unit {
    #[inline]
    fn mutate(&mut self, _c: &mut Candidates, _value: &mut ()) -> Result<()> {
        Ok(())
    }

    #[inline]
    fn mutation_count(&self, _value: &(), _shrink: bool) -> core::option::Option<u32> {
        Some(0)
    }
}

impl Generate<()> for Unit {
    #[inline]
    fn generate(&mut self, _ctx: &mut Context) -> Result<()> {
        Ok(())
    }
}

impl DefaultMutate for () {
    type DefaultMutate = Unit;
}

/// A mutator for fixed-size arrays.
///
/// See the [`array()`] function to create a new `Array` mutator and for example
/// usage.
#[derive(Clone, Debug, Default)]
pub struct Array<const N: usize, M> {
    mutator: M,
}

/// Create a new `Array` mutator.
///
/// # Example
///
/// ```
/// use mutatis::{mutators as m, Mutate, Session};
///
/// let mut mutator = m::array(m::u8());
/// let mut session = Session::new();
///
/// let mut value = [1, 2, 3, 4];
/// session.mutate_with(&mut mutator, &mut value).unwrap();
///
/// println!("mutated array is {value:?}");
/// ```
pub fn array<const N: usize, M>(mutator: M) -> Array<N, M> {
    Array { mutator }
}

impl<const N: usize, M, T> Mutate<[T; N]> for Array<N, M>
where
    M: Mutate<T>,
{
    #[inline]
    fn mutate(&mut self, c: &mut Candidates, value: &mut [T; N]) -> Result<()> {
        for element in value.iter_mut() {
            self.mutator.mutate(c, element)?;
        }
        Ok(())
    }

    #[inline]
    fn mutation_count(&self, value: &[T; N], shrink: bool) -> core::option::Option<u32> {
        let mut count = 0u32;
        for element in value.iter() {
            count += self.mutator.mutation_count(element, shrink)?;
        }
        Some(count)
    }
}

impl<const N: usize, M, T> Generate<[T; N]> for Array<N, M>
where
    M: Generate<T>,
{
    #[inline]
    fn generate(&mut self, ctx: &mut Context) -> Result<[T; N]> {
        let mut arr: [core::mem::MaybeUninit<T>; N] =
            core::array::from_fn(|_| core::mem::MaybeUninit::uninit());
        for elem in arr.iter_mut() {
            elem.write(self.mutator.generate(ctx)?);
        }
        Ok(unsafe { core::mem::transmute_copy(&arr) })
    }
}

impl<const N: usize, T> DefaultMutate for [T; N]
where
    T: DefaultMutate,
{
    type DefaultMutate = Array<N, T::DefaultMutate>;
}