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

// =============================================================================
//    Copyright (c) 2026 Haixing Hu.
//
//    SPDX-License-Identifier: Apache-2.0
//
//    Licensed under the Apache License, Version 2.0.
// =============================================================================
//! Encode context for one buffered encode step.

/// Context for one encode attempt inside a buffered encoder engine.
///
/// The context carries the current input value and output cursor. It does not
/// contain the prepared [`crate::EncodePlan`]; the engine keeps planning
/// separate so callers and hooks can distinguish cursor state from policy
/// state.
///
/// # Type Parameters
///
/// - `Value`: Logical input value type.
/// - `Unit`: Encoded output unit type.
#[derive(Debug)]
pub struct EncodeContext<'a, Value, Unit> {
    /// Input value being encoded.
    pub input_value: &'a Value,

    /// Absolute input index of [`input_value`](Self::input_value).
    pub input_index: usize,

    /// Complete output unit slice visible to the encoder.
    pub output: &'a mut [Unit],

    /// Start position in [`output`](Self::output) where writing begins.
    pub output_index: usize,
}

impl<Value, Unit> EncodeContext<'_, Value, Unit> {
    /// Returns writable output units from the current output index.
    ///
    /// # Returns
    ///
    /// Returns output capacity visible to this encode step.
    #[must_use]
    #[inline(always)]
    pub fn available_output(&self) -> usize {
        self.output.len().saturating_sub(self.output_index)
    }
}