pbt 0.5.11

High-throughput property-based testing with `derive`, swarm-testing, precise sizing, and full graph-theoretic type analysis over mutually inductive and uninstantiable types.
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

//! Generate an arbitrary term of any type `T`.

use {
    crate::{
        Pbt,
        hash::map,
        persist,
        reflection::{Uninstantiable, register_globally},
        size::Size,
        swarm::Swarm,
    },
    wyrand::WyRand,
};

/// Generate arbitrary terms without a replay prefix.
#[inline]
#[expect(
    clippy::expect_used,
    reason = "Internal invariants: violations should fail loudly."
)]
fn generate<T>(prng: &mut WyRand) -> Result<impl Iterator<Item = T>, Uninstantiable>
where
    T: Pbt,
{
    let mut swarm_cache = map();
    let mut swarm = Swarm::new::<T>(prng, &mut swarm_cache)?;
    let mut batch_size = 1_usize; // Increases over time.
    let mut remaining_in_batch = batch_size;
    Ok(Size::increasing().map(move |size| {
        if let Some(decremented) = remaining_in_batch.checked_sub(1) {
            remaining_in_batch = decremented;
        } else {
            remaining_in_batch = batch_size;
            #[expect(
                clippy::arithmetic_side_effects,
                reason = "The hardware will die before batch size overflows."
            )]
            let () = batch_size += 1;
            swarm = Swarm::new::<T>(prng, &mut swarm_cache)
                .expect("INTERNAL ERROR (`pbt`): instantiability changed mid-generation");
        }
        swarm.arbitrary(size, prng)
    }))
}

/// Generate an arbitrary term of any type `T`.
///
/// # Errors
///
/// If `T` is uninstantiable.
#[inline]
pub(crate) fn arbitrary<T>(prng: &mut WyRand) -> Result<impl Iterator<Item = T>, Uninstantiable>
where
    T: Pbt,
{
    let () = register_globally::<T>();
    let generated = generate(prng)?;
    Ok(persist::replay().into_iter().chain(generated))
}

/// Generate arbitrary terms without replaying persisted witnesses.
///
/// # Errors
///
/// If `T` is uninstantiable.
#[inline]
pub(crate) fn arbitrary_without_replay<T>(
    prng: &mut WyRand,
) -> Result<impl Iterator<Item = T>, Uninstantiable>
where
    T: Pbt,
{
    let () = register_globally::<T>();
    generate(prng)
}