qubit-codec 0.16.1

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

// =============================================================================
//    Copyright (c) 2026 Haixing Hu.
//
//    SPDX-License-Identifier: Apache-2.0
//
//    Licensed under the Apache License, Version 2.0.
// =============================================================================
//! Tests the messages and error contracts of value-codec ID protocol failures.

use std::error::Error;

use qubit_codec::ValueCodecIdError;

#[test]
fn test_each_variant_renders_its_documented_message() {
    let messages = [
        (ValueCodecIdError::Empty, "value codec ID cannot be empty"),
        (
            ValueCodecIdError::EmptySegment,
            "value codec ID contains an empty segment",
        ),
        (
            ValueCodecIdError::InvalidSegment,
            "value codec ID contains an invalid segment",
        ),
    ];

    for (error, expected) in messages {
        assert_eq!(
            error.to_string(),
            expected,
            "the Display message of {error:?} must identify the violated protocol rule"
        );
    }
}

#[test]
fn test_variant_messages_are_distinguishable() {
    assert_ne!(
        ValueCodecIdError::Empty.to_string(),
        ValueCodecIdError::EmptySegment.to_string(),
        "callers must be able to tell an empty ID from an empty segment"
    );
    assert_ne!(
        ValueCodecIdError::EmptySegment.to_string(),
        ValueCodecIdError::InvalidSegment.to_string(),
        "callers must be able to tell an empty segment from an invalid character"
    );
}

#[test]
fn test_debug_names_the_variant_for_diagnostics() {
    assert_eq!(
        format!("{:?}", ValueCodecIdError::EmptySegment),
        "EmptySegment",
        "the derived Debug output must name the violated protocol rule"
    );
}

#[test]
fn test_variants_are_comparable_for_equality_checks() {
    assert_eq!(
        ValueCodecIdError::InvalidSegment,
        ValueCodecIdError::InvalidSegment,
        "identical protocol violations must compare equal"
    );
    assert_ne!(
        ValueCodecIdError::Empty,
        ValueCodecIdError::InvalidSegment,
        "different protocol violations must not compare equal"
    );
}

#[test]
fn test_copying_an_error_keeps_both_copies_usable() {
    let original = ValueCodecIdError::EmptySegment;
    let copied = original;

    assert_eq!(
        original, copied,
        "copying a `Copy` error must not invalidate either handle"
    );
}

#[test]
fn test_error_has_no_further_source_error() {
    let error: &dyn Error = &ValueCodecIdError::Empty;

    assert!(
        error.source().is_none(),
        "a bare protocol violation must not report a nested source error"
    );
}

#[test]
fn test_error_can_be_raised_through_the_standard_error_trait() {
    fn failing() -> Result<(), ValueCodecIdError> {
        Err(ValueCodecIdError::InvalidSegment)
    }

    let boxed: Box<dyn Error> = Box::new(failing().expect_err("the error must be reported"));

    assert_eq!(
        boxed.to_string(),
        "value codec ID contains an invalid segment",
        "the protocol violation must survive being boxed as a trait object"
    );
}