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

use super::*;

/// The default mutator for `VecDeque<T>` values.
///
/// See the [`vec_deque()`] function to create new instances and for example
/// usage.
#[derive(Clone, Debug, Default)]
pub struct VecDeque<M> {
    mutator: M,
}

/// Create a new mutator for `VecDeque<T>` values.
///
/// # Example
///
/// ```
/// # fn foo() -> mutatis::Result<()> {
/// use mutatis::{mutators as m, Mutate, Session};
/// use std::collections::VecDeque;
///
/// let mut items: VecDeque<u32> = VecDeque::new();
///
/// let mut mutator = m::vec_deque(m::mrange(100..=199));
///
/// let mut session = Session::new();
/// for _ in 0..5 {
///     session.mutate_with(&mut mutator, &mut items)?;
///     println!("items = {items:?}");
/// }
///
/// // Example output:
/// //
/// //     items = [146]
/// //     items = [194]
/// //     items = []
/// //     items = [124]
/// //     items = [129, 124]
/// # Ok(()) }
/// # foo().unwrap();
/// ```
pub fn vec_deque<M>(mutator: M) -> VecDeque<M> {
    VecDeque { mutator }
}

impl<M, T> Mutate<alloc::collections::VecDeque<T>> for VecDeque<M>
where
    M: Generate<T> + Mutate<T>,
{
    #[inline]
    fn mutation_count(
        &self,
        value: &alloc::collections::VecDeque<T>,
        shrink: bool,
    ) -> core::option::Option<u32> {
        let mut count = 0u32;
        // Add an element.
        count += !shrink as u32;
        // Remove an element.
        count += !value.is_empty() as u32;
        // Swap two elements.
        count += (value.len() >= 2) as u32;
        // Mutate an existing element.
        for x in value.iter() {
            count += self.mutator.mutation_count(x, shrink)?;
        }
        Some(count)
    }

    #[inline]
    fn mutate(
        &mut self,
        c: &mut Candidates,
        value: &mut alloc::collections::VecDeque<T>,
    ) -> Result<()> {
        // Add an element.
        if !c.shrink() {
            c.mutation(|ctx| {
                let index = ctx.rng().gen_index(value.len() + 1).unwrap();
                let elem = self.mutator.generate(ctx)?;
                value.insert(index, elem);
                Ok(())
            })?;
        }

        // Remove an element.
        if !value.is_empty() {
            c.mutation(|ctx| {
                let index = ctx.rng().gen_index(value.len()).unwrap();
                value.remove(index);
                Ok(())
            })?;
        }

        // Swap two elements.
        if value.len() >= 2 {
            c.mutation(|ctx| {
                let i = ctx.rng().gen_index(value.len()).unwrap();
                let j = ctx.rng().gen_index(value.len()).unwrap();
                value.swap(i, j);
                Ok(())
            })?;
        }

        // Mutate an existing element.
        for x in value.iter_mut() {
            self.mutator.mutate(c, x)?;
        }

        Ok(())
    }
}

impl<M, T> Generate<alloc::collections::VecDeque<T>> for VecDeque<M>
where
    M: Generate<T>,
{
    #[inline]
    fn generate(&mut self, ctx: &mut Context) -> Result<alloc::collections::VecDeque<T>> {
        self.generate_via_mutate(ctx, 1)
    }
}

impl<T> DefaultMutate for alloc::collections::VecDeque<T>
where
    T: DefaultMutate,
    T::DefaultMutate: Generate<T>,
{
    type DefaultMutate = VecDeque<T::DefaultMutate>;
}