qubit-codec 0.8.0

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

// =============================================================================
//    Copyright (c) 2026 Haixing Hu.
//
//    SPDX-License-Identifier: Apache-2.0
//
//    Licensed under the Apache License, Version 2.0.
// =============================================================================
//! Domain-neutral codec decode error signals.

use core::num::NonZeroUsize;

/// Optional stream-recovery signals exposed by codec decode errors.
///
/// Concrete codec errors remain responsible for describing their own domain
/// failure. This trait only standardizes the small amount of control-flow
/// information that streaming adapters need when deciding whether to read more
/// input or consume invalid units before reporting an error.
pub trait CodecDecodeErrorSignal {
    /// Returns the total input units required from the current value start.
    ///
    /// # Returns
    ///
    /// Returns `Some(required)` for incomplete input prefixes, or `None` when
    /// the error does not request more input.
    #[must_use]
    #[inline(always)]
    fn required_total(&self) -> Option<usize> {
        None
    }

    /// Returns invalid input units that may be consumed to make progress.
    ///
    /// # Returns
    ///
    /// Returns `Some(consumed)` for malformed or non-canonical input that a
    /// streaming adapter may discard before surfacing the error, or `None`
    /// when no consumption hint is available.
    #[must_use]
    #[inline(always)]
    fn consumed_units(&self) -> Option<NonZeroUsize> {
        None
    }
}

impl CodecDecodeErrorSignal for core::convert::Infallible {}