qubit-codec 0.15.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

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

/// Reports why a [`crate::Transcoder`] stopped converting input.
///
/// # Examples
///
/// ```
/// use core::num::NonZeroUsize;
/// use qubit_codec::TranscodeStatus;
///
/// let status = TranscodeStatus::need_output(NonZeroUsize::new(2).unwrap());
/// assert!(matches!(status, TranscodeStatus::NeedOutput { required } if required.get() == 2));
/// ```
#[derive(Clone, Copy, Debug, Eq, PartialEq)]
pub enum TranscodeStatus {
    /// All currently supplied input was consumed.
    ///
    /// A `Complete` status means the current [`crate::Transcoder::transcode`]
    /// call consumed every input unit visible from the supplied `input_index`.
    /// Implementations must report [`NeedInput`](Self::NeedInput) for an
    /// incomplete input tail and [`NeedOutput`](Self::NeedOutput) when output
    /// capacity prevents further input consumption.
    Complete,

    /// More input is needed to complete the next output value.
    ///
    /// The transcoder does not consume incomplete input tails. The caller
    /// should preserve `input[input_index..]`, refill the input buffer when
    /// more data is available, or apply its EOF policy when the upstream
    /// source is closed. Calling [`crate::Transcoder::finish`] does not pass
    /// this tail back to the transcoder.
    ///
    /// - `required`: Current minimum total input units required before retrying
    ///   from the current input position. A later retry may raise this lower
    ///   bound.
    NeedInput {
        /// Current minimum total input units required before retrying from the
        /// current input position. A later retry may raise this lower bound.
        required: NonZeroUsize,
    },

    /// More output capacity is needed before conversion can continue.
    ///
    /// - `required`: Total output units required from the current output
    ///   position.
    NeedOutput {
        /// Total output units required from the current output position.
        required: NonZeroUsize,
    },
}

impl TranscodeStatus {
    /// Creates a status that requests more input.
    ///
    /// # Parameters
    ///
    /// - `required`: Current minimum total input units required before retrying
    ///   from the current input position. A later retry may raise this lower
    ///   bound.
    ///
    /// # Returns
    ///
    /// Returns a [`TranscodeStatus::NeedInput`] value.
    #[inline(always)]
    #[must_use]
    pub const fn need_input(required: NonZeroUsize) -> Self {
        Self::NeedInput { required }
    }

    /// Creates a status that requests more output capacity.
    ///
    /// # Parameters
    ///
    /// - `required`: Total output units required from the current output
    ///   position.
    ///
    /// # Returns
    ///
    /// Returns a [`TranscodeStatus::NeedOutput`] value.
    #[inline(always)]
    #[must_use]
    pub const fn need_output(required: NonZeroUsize) -> Self {
        Self::NeedOutput { required }
    }
}