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
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

// =============================================================================
//    Copyright (c) 2026 Haixing Hu.
//
//    SPDX-License-Identifier: Apache-2.0
//
//    Licensed under the Apache License, Version 2.0.
// =============================================================================
//! Internal pending-value encode step used by buffered converters.

use core::num::NonZeroUsize;

use super::pending_value::PendingValue;

/// Result of encoding a pending decoded value in the converter loop.
#[derive(Clone, Copy, Debug, Eq, Hash, PartialEq)]
pub(in crate::transcode) enum PendingEncodeStep<Value> {
    /// The pending value was fully written.
    Written {
        /// Number of target units written.
        written: usize,
    },
    /// The pending value could not be written because output is too small.
    NeedOutput {
        /// Retained value to write later.
        pending: PendingValue<Value>,
        /// Additional target units required to continue.
        additional: NonZeroUsize,
        /// Target units available at the output boundary.
        available: usize,
    },
}

impl<Value> PendingEncodeStep<Value> {
    /// Creates a successful pending-value encode step.
    ///
    /// # Parameters
    ///
    /// - `written`: Number of target units written.
    ///
    /// # Returns
    ///
    /// Returns a step that made output progress.
    #[inline(always)]
    pub(in crate::transcode) const fn written(written: usize) -> Self {
        Self::Written { written }
    }

    /// Creates a missing-output pending-value encode step.
    ///
    /// # Parameters
    ///
    /// - `pending`: Decoded value that must remain retained.
    /// - `additional`: Additional output capacity required to continue.
    /// - `available`: Output capacity currently available.
    ///
    /// # Returns
    ///
    /// Returns a step containing the retained value and shortage.
    #[inline(always)]
    pub(in crate::transcode) const fn need_output(
        pending: PendingValue<Value>,
        additional: NonZeroUsize,
        available: usize,
    ) -> Self {
        Self::NeedOutput {
            pending,
            additional,
            available,
        }
    }
}