quamina 0.6.0

Fast pattern-matching library for filtering JSON events
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

//! Kani proof harnesses for verifying real invariants.
//!
//! These proofs use bounded model checking to exhaustively verify properties
//! of core data structures and algorithms. Run with: `cargo kani`
//!
//! Arena-specific proofs live in src/automaton/arena.rs::kani_arena_proofs
//! (locality with the code they verify):
//! - `smalltable_pack_dstep_roundtrip`: SmallTable pack/dstep roundtrip
//!   (bounded to 3-region tables to keep the proof tractable)

#[cfg(kani)]
mod case_fold_proofs {
    use crate::case_folding::CASE_FOLDING_PAIRS;

    /// Prove: CASE_FOLDING_PAIRS is sorted by first element.
    ///
    /// Binary search in case_fold_char relies on this invariant. We check
    /// that table[i].0 < table[i+1].0 for a symbolic index covering all
    /// adjacent pairs.
    #[kani::proof]
    fn case_fold_table_sorted() {
        let i: usize = kani::any();
        kani::assume(i < CASE_FOLDING_PAIRS.len() - 1);
        kani::assert(
            CASE_FOLDING_PAIRS[i].0 < CASE_FOLDING_PAIRS[i + 1].0,
            "CASE_FOLDING_PAIRS must be sorted by first element",
        );
    }
}

#[cfg(kani)]
mod numbits_proofs {
    use crate::numbits::{MAX_BYTES_IN_ENCODING, numbits_from_f64, to_q_number_stack};

    /// Prove: to_q_number_stack never exceeds MAX_BYTES_IN_ENCODING (10) for any u64.
    ///
    /// The variable-width base-128 encoding strips trailing zero septets,
    /// so the length is always in [0, 10]. This verifies the len field
    /// fits the fixed-size stack buffer.
    #[kani::proof]
    #[kani::unwind(11)]
    fn q_number_stack_encoding_bounds() {
        let input: u64 = kani::any();
        let result = to_q_number_stack(input);
        kani::assert(
            result.len() <= MAX_BYTES_IN_ENCODING,
            "Q-number length must not exceed MAX_BYTES_IN_ENCODING",
        );
    }

    /// Prove: numbits_from_f64 preserves ordering for finite, non-NaN floats.
    ///
    /// If a < b as f64, then numbits_from_f64(a) < numbits_from_f64(b) as u64.
    /// This is the core invariant that makes automaton-based numeric matching work.
    #[kani::proof]
    fn numbits_ordering_preserves_f64() {
        let a: f64 = kani::any();
        let b: f64 = kani::any();

        kani::assume(a.is_finite());
        kani::assume(b.is_finite());
        kani::assume(a < b);

        let na = numbits_from_f64(a);
        let nb = numbits_from_f64(b);

        kani::assert(na < nb, "numbits must preserve f64 ordering");
    }
}