qubit-codec 0.17.4

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

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

//! Type-erased value-codec execution errors.

use std::any::TypeId;
use std::error::Error;

use thiserror::Error;

/// Failure produced by a type-erased value-codec invocation.
///
/// Registry lookups erase the concrete encoder and decoder types, so the
/// mismatch and failure they report are carried here as diagnostics instead of
/// a generic type parameter.
/// Source errors are retained as `Send + Sync` trait objects so this error can
/// cross thread boundaries without losing the concrete source type.
///
/// # Examples
///
/// ```
/// use std::any::TypeId;
///
/// use qubit_codec::ValueCodecExecutionError;
///
/// let error = ValueCodecExecutionError::TypeMismatch {
///     expected_type: "u32",
///     actual_type: TypeId::of::<String>(),
/// };
/// assert_eq!(
///     error.to_string(),
///     format!("value codec for u32 received incompatible type {:?}", TypeId::of::<String>())
/// );
/// ```
#[derive(Debug, Error)]
#[must_use]
pub enum ValueCodecExecutionError {
    /// The supplied value has the wrong Rust type.
    #[error("value codec for {expected_type} received incompatible type {actual_type:?}")]
    TypeMismatch {
        /// Expected diagnostic Rust type name.
        expected_type: &'static str,
        /// Actual process-local Rust type identity.
        actual_type: TypeId,
    },
    /// The typed encoder failed.
    #[error("value codec {codec_type} failed to encode: {source}")]
    EncodeFailed {
        /// Diagnostic Rust codec type name.
        codec_type: &'static str,
        /// Typed encoder source error.
        #[source]
        source: Box<dyn Error + Send + Sync + 'static>,
    },
    /// The typed decoder failed.
    #[error("value codec {codec_type} failed to decode: {source}")]
    DecodeFailed {
        /// Diagnostic Rust codec type name.
        codec_type: &'static str,
        /// Typed decoder source error.
        #[source]
        source: Box<dyn Error + Send + Sync + 'static>,
    },
}