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

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

use qubit_codec::TranscodeDomainError;
use qubit_codec::TranscodeEncodeError;
use qubit_codec::TranscodeFailure;

#[derive(Clone, Copy, Debug, Eq, PartialEq, thiserror::Error)]
#[error("domain error")]
struct DomainError;

#[test]
fn test_encode_error_carries_unencodable_value_context() {
    let error = TranscodeEncodeError::<DomainError, char>::unencodable(4, 'x');
    assert_eq!(Some((4, Some(&'x'))), error.unencodable_ref());

    let mapped = error.map_value(|value| value as u32);
    assert_eq!(
        TranscodeEncodeError::<DomainError, u32>::unencodable(4, 'x' as u32),
        mapped,
    );
}

#[test]
fn test_encode_error_accessors_mapping_and_validation() {
    let failure = TranscodeEncodeError::<&str, char>::Failure(TranscodeFailure::incomplete_input(1, 2, 0));
    let trailing = TranscodeEncodeError::<&str, char>::Failure(TranscodeFailure::trailing_input(1, 1));
    let domain = TranscodeEncodeError::<&str, char>::domain_reset("reset");
    let main = TranscodeEncodeError::<&str, char>::domain_main("encode", 3);
    let finish = TranscodeEncodeError::<&str, char>::domain_finish("finish");
    let no_context = TranscodeEncodeError::<&str, char>::unencodable_without_context(8);

    assert!(
        !failure.is_domain(),
        "framework failures must not be classified as domain errors"
    );
    assert!(domain.is_domain(), "domain errors must be classified as domain errors");
    assert!(
        matches!(trailing.failure_ref(), Some(TranscodeFailure::TrailingInput { .. })),
        "trailing input must expose its framework failure"
    );
    assert_eq!(None, domain.failure_ref());
    assert_eq!(None, failure.domain_error_ref());
    assert_eq!(
        Some(&TranscodeDomainError::Reset { source: "reset" }),
        domain.domain_error_ref(),
    );
    assert_eq!(Some(&"reset"), domain.domain_ref());
    assert_eq!(None, failure.domain_ref());
    assert_eq!(None, failure.unencodable_ref());
    assert_eq!(Some((8, None)), no_context.unencodable_ref());
    assert_eq!(None, domain.unencodable_ref());

    assert_eq!(
        TranscodeEncodeError::Failure(TranscodeFailure::incomplete_input(1, 2, 0)),
        failure.map_domain(str::len),
    );
    assert_eq!(
        TranscodeEncodeError::<usize, char>::unencodable_without_context(8),
        no_context.map_domain(str::len),
    );
    assert_eq!(
        TranscodeEncodeError::<usize, char>::domain_main(6, 3),
        main.map_domain(str::len),
    );
    assert_eq!(
        TranscodeEncodeError::<&str, u32>::domain_finish("finish"),
        finish.map_value(|value: char| value as u32),
    );
    assert_eq!(
        TranscodeEncodeError::Failure(TranscodeFailure::trailing_input(1, 1)),
        TranscodeEncodeError::<&str, char>::from(TranscodeFailure::trailing_input(1, 1))
            .map_value(|value: char| value as u32),
    );

    assert_eq!(
        Ok::<(), TranscodeEncodeError<&str, char>>(()),
        TranscodeFailure::ensure_output_index(2, 2).map_err(TranscodeEncodeError::<&str, char>::from)
    );
    assert!(
        matches!(
            TranscodeFailure::ensure_output_index(2, 3).map_err(TranscodeEncodeError::<&str, char>::from),
            Err(TranscodeEncodeError::Failure(
                TranscodeFailure::InvalidOutputIndex { .. }
            ))
        ),
        "an output index beyond the output length must be rejected"
    );
    assert_eq!(
        Ok::<(), TranscodeEncodeError<&str, char>>(()),
        TranscodeFailure::ensure_transcode_indices(2, 1, 2, 1).map_err(TranscodeEncodeError::<&str, char>::from),
    );
    assert!(
        matches!(
            TranscodeFailure::ensure_transcode_indices(2, 3, 2, 1).map_err(TranscodeEncodeError::<&str, char>::from),
            Err(TranscodeEncodeError::Failure(
                TranscodeFailure::InvalidInputIndex { .. }
            ))
        ),
        "an input index beyond the input length must be rejected"
    );
    assert_eq!(
        Ok::<(), TranscodeEncodeError<&str, char>>(()),
        TranscodeFailure::ensure_output_capacity(3, 1, 2).map_err(TranscodeEncodeError::<&str, char>::from),
    );
    assert!(
        matches!(
            TranscodeFailure::ensure_output_capacity(3, 1, 3).map_err(TranscodeEncodeError::<&str, char>::from),
            Err(TranscodeEncodeError::Failure(
                TranscodeFailure::InsufficientOutput { .. }
            ))
        ),
        "insufficient output capacity must be rejected"
    );
}