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
70
71
72
73

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

/// Error reported when a transcoder returns inconsistent progress.
///
/// This error represents a broken [`crate::Transcoder`] implementation rather
/// than malformed input data. Buffered drivers call
/// [`crate::TranscodeProgress::validate`] before trusting progress counters for
/// unchecked buffer cursor movement.
///
/// # Examples
///
/// ```
/// use qubit_codec::TranscodeContractError;
///
/// let error = TranscodeContractError::OverRead { read: 2, available: 1 };
/// assert_eq!(error.to_string(), "transcoder consumed 2 units but only 1 were available");
/// ```
#[derive(Clone, Copy, Debug, Eq, Error, Hash, PartialEq)]
#[non_exhaustive]
#[must_use]
pub enum TranscodeContractError {
    /// The transcoder consumed more input units than the caller supplied.
    #[error("transcoder consumed {read} units but only {available} were available")]
    OverRead {
        /// Input units reported as consumed.
        read: usize,
        /// Input units available to the transcode call.
        available: usize,
    },

    /// The transcoder wrote more output units than the caller supplied.
    #[error("transcoder wrote {written} units but only {available} output slots were available")]
    OverWritten {
        /// Output units reported as written.
        written: usize,
        /// Output slots available to the transcode call.
        available: usize,
    },

    /// Progress could not be represented as an absolute index.
    #[error("transcoder progress overflow: index {index} plus advanced {advanced}")]
    ProgressIndexOverflow {
        /// Absolute index supplied to the transcode call.
        index: usize,
        /// Relative progress reported by the transcoder.
        advanced: usize,
    },

    /// A status requested input or output that is already available.
    #[error("transcoder reported required {required} with available {available}")]
    SatisfiedNeed {
        /// Required units reported by the status.
        required: usize,
        /// Available units reported by the status.
        available: usize,
    },

    /// A `Complete` status left visible input unconsumed.
    #[error("transcoder reported Complete after consuming {read} of {available} available input units")]
    CompleteWithRemainingInput {
        /// Input units reported as consumed.
        read: usize,
        /// Input units available to the transcode call.
        available: usize,
    },
}