qubit-codec-misc 0.3.0

Miscellaneous byte and text format codecs for Rust applications
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

// =============================================================================
//    Copyright (c) 2026 Haixing Hu.
//
//    SPDX-License-Identifier: Apache-2.0
//
//    Licensed under the Apache License, Version 2.0.
// =============================================================================
//! Private parser outcome used by streaming codecs.

use core::num::NonZeroUsize;

use crate::MiscCodecError;
use qubit_codec::DecodeFailure;

/// Distinguishes retryable stream tails from malformed codec input.
#[derive(Debug)]
pub(crate) enum ParseError {
    /// More input is required before a value can be decided.
    Incomplete {
        /// Total units required from the current value start.
        required: NonZeroUsize,
    },
    /// The input is malformed.
    Invalid(MiscCodecError),
}

impl From<MiscCodecError> for ParseError {
    #[inline]
    fn from(error: MiscCodecError) -> Self {
        Self::Invalid(error)
    }
}

impl ParseError {
    /// Converts a parser outcome while retaining a known invalid width.
    #[inline]
    pub(crate) fn into_decode_failure_with_consumed(
        self,
        consumed: NonZeroUsize,
    ) -> DecodeFailure<MiscCodecError> {
        match self {
            Self::Incomplete { required, .. } => {
                DecodeFailure::incomplete(required)
            }
            Self::Invalid(error) => DecodeFailure::invalid(error, consumed),
        }
    }
}