qubit-codec 0.17.3

Core codec traits and buffer conversion primitives for 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

// =============================================================================
//    Copyright (c) 2026 Haixing Hu.
//
//    SPDX-License-Identifier: Apache-2.0
//
//    Licensed under the Apache License, Version 2.0.
// =============================================================================

/// Advances the deterministic xorshift generator used by sequence tests.
pub fn next(state: &mut u64) -> u64 {
    *state ^= *state << 13;
    *state ^= *state >> 7;
    *state ^= *state << 17;
    *state
}

/// Generates a bounded payload reproducibly from a seed.
pub fn payload(seed: u64) -> Vec<u8> {
    let mut state = seed + 1;
    let len = (next(&mut state) % 49) as usize;
    (0..len).map(|_| next(&mut state) as u8).collect()
}

#[derive(Clone, Copy, Debug, Eq, PartialEq)]
pub enum IoEvent {
    ReadyShort(usize),
    PendingThenWake,
    FailOnce,
    Ready,
}

#[derive(Clone, Copy, Debug, Eq, PartialEq)]
pub enum OutputAction {
    Reset,
    Transcode(usize),
    Drain,
    Flush,
    CancelDrain,
    RecoverWrite,
    Finish,
}

#[derive(Clone, Copy, Debug, Eq, PartialEq)]
pub enum InputAction {
    Reset,
    Refill,
    Transcode,
    CancelRead,
    RecoverRead,
    Eof,
    EofStep,
    Finish,
}

/// Generates a bounded legal output action schedule reproducibly from a seed.
pub fn output_actions(seed: u64, payload_len: usize) -> Vec<OutputAction> {
    let mut state = seed + 1;
    let mut actions = vec![OutputAction::Reset];
    if matches!(io_events(seed).1, IoEvent::PendingThenWake) {
        actions.extend([OutputAction::CancelDrain, OutputAction::Drain]);
    }
    if seed.is_multiple_of(13) {
        actions.extend([OutputAction::Drain, OutputAction::RecoverWrite]);
    }
    let mut planned = 0;
    while planned < payload_len {
        match next(&mut state) % 12 {
            0 => actions.push(OutputAction::Reset),
            1 => actions.push(OutputAction::Drain),
            2 => actions.push(OutputAction::Flush),
            3 if planned > 0 => actions.push(OutputAction::Drain),
            _ => {}
        }
        let amount = (1 + (next(&mut state) % 4) as usize).min(payload_len - planned);
        actions.push(OutputAction::Transcode(amount));
        planned += amount;
        assert!(
            actions.len() <= 128,
            "seed={seed}, action={}, poll=0: output action budget exceeded",
            actions.len()
        );
    }
    actions.push(OutputAction::Finish);
    actions.push(OutputAction::Flush);
    assert!(
        actions.len() <= 128,
        "seed={seed}, action={}, poll=0: output action budget exceeded",
        actions.len()
    );
    actions
}

/// Generates a bounded legal input action schedule for a capacity and read
/// chunk.
pub fn input_actions(seed: u64, payload_len: usize, capacity: usize, chunk: usize) -> Vec<InputAction> {
    let mut state = seed + 1;
    let mut actions = vec![InputAction::Reset];
    if payload_len == 0 {
        if seed.is_multiple_of(13) {
            actions.extend([InputAction::Refill, InputAction::RecoverRead]);
        }
        actions.extend([InputAction::Eof, InputAction::EofStep, InputAction::Finish]);
        return actions;
    }
    let step = capacity.min(chunk).max(1);
    let groups = payload_len.div_ceil(step).max(1);
    if matches!(io_events(seed).0, IoEvent::PendingThenWake) && next(&mut state).is_multiple_of(2) {
        actions.push(InputAction::CancelRead);
    }
    actions.push(InputAction::Refill);
    if seed.is_multiple_of(13) {
        actions.push(InputAction::RecoverRead);
    }
    for group in 0..groups {
        actions.push(InputAction::Transcode);
        if group + 1 < groups {
            actions.push(InputAction::Refill);
        }
    }
    actions.extend([InputAction::Eof, InputAction::EofStep, InputAction::Finish]);
    assert!(
        actions.len() <= 128,
        "seed={seed}, action={}, poll=0: input action budget exceeded",
        actions.len()
    );
    actions
}

/// Chooses deterministic I/O events without using process randomness.
pub fn io_events(seed: u64) -> (IoEvent, IoEvent) {
    let mut state = seed + 1;
    let write = if seed.is_multiple_of(13) {
        IoEvent::FailOnce
    } else {
        match next(&mut state) % 4 {
            0 => IoEvent::ReadyShort(1 + (next(&mut state) % 4) as usize),
            1 => IoEvent::PendingThenWake,
            _ => IoEvent::Ready,
        }
    };
    let read = if seed.is_multiple_of(13) {
        IoEvent::FailOnce
    } else {
        match next(&mut state) % 4 {
            0 => IoEvent::ReadyShort(1 + (next(&mut state) % 4) as usize),
            1 => IoEvent::PendingThenWake,
            _ => IoEvent::Ready,
        }
    };
    (read, write)
}