qubit-codec 0.11.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
72
73
74
75
76
77
78
79
80
81
82
83
84

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

/// Read-only context supplied to an encode policy hook.
///
/// The engine retains ownership of the mutable output slice. Hooks can inspect
/// the current value and cursor/capacity metadata, then return an
/// [`crate::engine::EncodeUnencodableAction`] without being able to mutate
/// output behind the engine's progress accounting.
///
/// # Type Parameters
///
/// - `Value`: Logical input value type.
#[derive(Clone, Copy, Debug, Eq, Hash, PartialEq)]
pub struct EncodeContext<'a, Value> {
    input_value: &'a Value,
    input_index: usize,
    output_index: usize,
    available_output: usize,
}

impl<'a, Value> EncodeContext<'a, Value> {
    /// Creates an encode policy context.
    ///
    /// # Parameters
    ///
    /// - `input_value`: Borrowed input value being encoded.
    /// - `input_index`: Absolute input index of `input_value`.
    /// - `output_index`: Absolute output index where writing begins.
    /// - `available_output`: Output units writable from `output_index`.
    ///
    /// # Returns
    ///
    /// Returns a read-only encode context.
    #[inline(always)]
    #[must_use]
    pub const fn new(
        input_value: &'a Value,
        input_index: usize,
        output_index: usize,
        available_output: usize,
    ) -> Self {
        Self {
            input_value,
            input_index,
            output_index,
            available_output,
        }
    }

    /// Returns the input value being encoded.
    #[inline(always)]
    #[must_use]
    pub const fn input_value(&self) -> &Value {
        self.input_value
    }

    /// Returns the absolute input index of the current value.
    #[inline(always)]
    #[must_use]
    pub const fn input_index(&self) -> usize {
        self.input_index
    }

    /// Returns the absolute output index where writing begins.
    #[inline(always)]
    #[must_use]
    pub const fn output_index(&self) -> usize {
        self.output_index
    }

    /// Returns output capacity visible to this encode attempt.
    #[inline(always)]
    #[must_use]
    pub const fn available_output(&self) -> usize {
        self.available_output
    }
}