qubit-codec 0.8.0

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
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169

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

use qubit_codec::CodecEncodeError;

#[derive(Clone, Copy, Debug, Eq, PartialEq)]
struct TestEncodeError;

#[test]
fn test_codec_encode_error_wraps_codec_error() {
    let error = CodecEncodeError::encode(TestEncodeError, 7);

    assert_eq!(
        CodecEncodeError::Encode {
            source: TestEncodeError,
            input_index: 7,
        },
        error,
    );
}

#[test]
fn test_codec_encode_error_reports_invalid_input_index() {
    let error = CodecEncodeError::<TestEncodeError>::invalid_input_index(5, 2);

    assert_eq!(
        CodecEncodeError::InvalidInputIndex { index: 5, len: 2 },
        error
    );
}

#[test]
fn test_codec_encode_error_reports_unencodable_value() {
    let error = CodecEncodeError::<TestEncodeError>::unencodable_value(7);

    assert_eq!(CodecEncodeError::UnencodableValue { input_index: 7 }, error);
    assert!(
        CodecEncodeError::<&'static str>::unencodable_value(7)
            .to_string()
            .contains("unencodable value")
    );
}

#[test]
fn test_codec_encode_error_reports_invalid_output_index() {
    let error = CodecEncodeError::<TestEncodeError>::invalid_output_index(5, 2);

    assert_eq!(
        CodecEncodeError::InvalidOutputIndex { index: 5, len: 2 },
        error
    );
}

#[test]
fn test_codec_encode_error_reports_insufficient_output() {
    let error =
        CodecEncodeError::<TestEncodeError>::insufficient_output(2, 4, 1);

    assert_eq!(
        CodecEncodeError::InsufficientOutput {
            output_index: 2,
            required: 4,
            available: 1,
        },
        error,
    );
    assert!(
        CodecEncodeError::<&'static str>::insufficient_output(2, 4, 1)
            .to_string()
            .contains("insufficient output")
    );
}

#[test]
fn test_codec_encode_error_reports_output_length_overflow() {
    let error = CodecEncodeError::<TestEncodeError>::output_length_overflow();

    assert_eq!(CodecEncodeError::OutputLengthOverflow, error);
    assert!(
        CodecEncodeError::<&'static str>::output_length_overflow()
            .to_string()
            .contains("output length arithmetic overflow")
    );
}

#[test]
fn test_codec_encode_error_display_formats_framework_variants() {
    assert!(
        CodecEncodeError::<&'static str>::invalid_input_index(1, 0)
            .to_string()
            .contains("invalid input index")
    );
    assert!(
        CodecEncodeError::<&'static str>::invalid_output_index(1, 0)
            .to_string()
            .contains("invalid output index")
    );
    assert!(
        CodecEncodeError::encode("codec failure", 2)
            .to_string()
            .contains("codec encode error")
    );
}

#[test]
fn test_codec_encode_error_ensure_input_index_accepts_valid_index() {
    CodecEncodeError::<TestEncodeError>::ensure_input_index(4, 2)
        .expect("valid index");
}

#[test]
fn test_codec_encode_error_ensure_input_index_rejects_out_of_range() {
    let error = CodecEncodeError::<TestEncodeError>::ensure_input_index(2, 5)
        .expect_err("out-of-range index");

    assert_eq!(CodecEncodeError::invalid_input_index(5, 2), error);
}

#[test]
fn test_codec_encode_error_ensure_output_index_accepts_valid_index() {
    CodecEncodeError::<TestEncodeError>::ensure_output_index(4, 4)
        .expect("valid index");
}

#[test]
fn test_codec_encode_error_ensure_output_index_rejects_out_of_range() {
    let error = CodecEncodeError::<TestEncodeError>::ensure_output_index(1, 2)
        .expect_err("out-of-range index");

    assert_eq!(CodecEncodeError::invalid_output_index(2, 1), error);
}

#[test]
fn test_codec_encode_error_ensure_output_capacity_accepts_sufficient_capacity()
{
    CodecEncodeError::<TestEncodeError>::ensure_output_capacity(4, 1, 2)
        .expect("sufficient capacity");
}

#[test]
fn test_codec_encode_error_ensure_output_capacity_delegates_to_output_index() {
    let error =
        CodecEncodeError::<TestEncodeError>::ensure_output_capacity(2, 5, 0)
            .expect_err("out-of-range index");

    assert_eq!(CodecEncodeError::invalid_output_index(5, 2), error);
}

#[test]
fn test_codec_encode_error_ensure_output_capacity_rejects_insufficient_capacity()
 {
    let error =
        CodecEncodeError::<TestEncodeError>::ensure_output_capacity(4, 2, 3)
            .expect_err("insufficient capacity");

    assert_eq!(
        CodecEncodeError::InsufficientOutput {
            output_index: 2,
            required: 3,
            available: 2,
        },
        error,
    );
}