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

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

use core::convert::Infallible;
use core::num::NonZeroUsize;

use qubit_codec::Codec;
use qubit_codec::DecodeFailure;

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

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

#[derive(Debug, Eq, PartialEq)]
struct NonDefaultValue(Vec<u8>);

impl Codec for PlainCodec {
    type Value = NonDefaultValue;
    type Unit = u8;
    type DecodeError = DomainDecodeError;
    type EncodeError = Infallible;

    const MIN_UNITS_PER_VALUE: usize = 1;

    const MAX_ENCODE_UNITS_PER_VALUE: usize = 1;

    const MAX_DECODE_UNITS_PER_VALUE: usize = 2;

    unsafe fn decode(
        &mut self,
        input: &[u8],
        input_index: usize,
    ) -> Result<(NonDefaultValue, NonZeroUsize), DecodeFailure<Self::DecodeError>> {
        if input[input_index] == 0xff {
            return Err(DecodeFailure::invalid(DomainDecodeError, NonZeroUsize::MIN));
        }
        Ok((NonDefaultValue(vec![input[input_index]]), NonZeroUsize::MIN))
    }

    unsafe fn encode(
        &mut self,
        value: &NonDefaultValue,
        output: &mut [u8],
        output_index: usize,
    ) -> Result<usize, Self::EncodeError> {
        output[output_index] = value.0[0];
        Ok(1)
    }
}

#[test]
fn test_decode_failure_reports_incomplete_control_flow() {
    let required_total = crate::nonzero(3);
    let failure = DecodeFailure::<DomainDecodeError>::incomplete(required_total);

    assert_eq!(DecodeFailure::incomplete(required_total), failure,);
    assert_eq!(Some(required_total), failure.required_total());
    assert_eq!(None, failure.invalid_source());
    assert_eq!(None, failure.consumed_units());
}

#[test]
fn test_decode_failure_preserves_incomplete_domain_error() {
    let required_total = crate::nonzero(3);
    let failure = DecodeFailure::incomplete_with_source(DomainDecodeError, required_total);

    assert_eq!(
        DecodeFailure::incomplete_with_source(DomainDecodeError, required_total),
        failure,
    );
    assert_eq!(Some(&DomainDecodeError), failure.incomplete_source());
    assert_eq!(Some(required_total), failure.required_total());
}

#[test]
fn test_decode_failure_reports_invalid_domain_error() {
    let consumed = crate::nonzero(2);
    let failure = DecodeFailure::invalid(DomainDecodeError, consumed);

    assert_eq!(DecodeFailure::invalid(DomainDecodeError, consumed), failure);
    assert_eq!(None, failure.required_total());
    assert_eq!(Some(&DomainDecodeError), failure.invalid_source());
    assert_eq!(Some(consumed), failure.consumed_units());
}

#[test]
fn test_decode_failure_reports_invalid_unknown_consumption() {
    let failure = DecodeFailure::invalid_unknown(DomainDecodeError);

    assert_eq!(DecodeFailure::invalid_unknown(DomainDecodeError), failure);
    assert_eq!(None, failure.required_total());
    assert_eq!(Some(&DomainDecodeError), failure.invalid_source());
    assert_eq!(None, failure.consumed_units());
}

#[test]
fn test_codec_trait_is_safe_and_accepts_non_copy_non_default_values() {
    let mut codec = PlainCodec;

    // SAFETY: The input contains one unit, satisfying PlainCodec's decode bound.
    let (decoded_value, _) = unsafe { codec.decode(&[0x41], 0) }.expect("plain codec should decode a value");
    assert_eq!(NonDefaultValue(vec![0x41]), decoded_value);

    let value = NonDefaultValue(vec![0x42]);
    let expected_len = codec.encode_len(&value);
    assert_eq!(1, expected_len);
    let mut output = [0_u8; 1];
    // SAFETY: The one-slot output satisfies PlainCodec's declared encoding bound.
    let written = unsafe { codec.encode(&value, &mut output, 0) }.expect("plain codec encode is infallible");
    assert_eq!(expected_len, written);
    assert_eq!([0x42], output);
}