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

use super::*;

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

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

impl<M, T> Mutate<alloc::collections::BinaryHeap<T>> for BinaryHeap<M>
where
    M: Generate<T>,
    T: Ord,
{
    #[inline]
    fn mutation_count(
        &self,
        value: &alloc::collections::BinaryHeap<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;
        // Replace a random element.
        count += !value.is_empty() as u32;
        Some(count)
    }

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

        // Remove an element.
        if !value.is_empty() {
            c.mutation(|_ctx| {
                value.pop();
                Ok(())
            })?;
        }

        // Replace a random element.
        if !value.is_empty() {
            c.mutation(|ctx| {
                let mut vec = core::mem::take(value).into_vec();
                let index = ctx.rng().gen_index(vec.len()).unwrap();
                vec[index] = self.mutator.generate(ctx)?;
                *value = alloc::collections::BinaryHeap::from(vec);
                Ok(())
            })?;
        }

        Ok(())
    }
}

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

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