qubit-codec 0.17.4

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

// =============================================================================
//    Copyright (c) 2026 Haixing Hu.
//
//    SPDX-License-Identifier: Apache-2.0
//
//    Licensed under the Apache License, Version 2.0.
// =============================================================================
//! Policy hooks used by the default codec-backed buffered encoder.

use super::super::super::engine::EncodeContext;
use super::super::super::engine::EncodeUnencodableAction;
use super::super::super::engine::TranscodeEncodeHooks;
use crate::Codec;
use crate::TranscodeEncodeErrorOf;

/// Policy hooks for [`crate::CodecTranscodeEncoder`].
#[derive(Clone, Copy, Debug, Default, Eq, Hash, PartialEq)]
pub(in crate::transcode) struct CodecTranscodeEncodeHooks;

impl<C> TranscodeEncodeHooks<C> for CodecTranscodeEncodeHooks
where
    C: Codec,
{
    /// Rejects values outside the wrapped codec's encodable domain.
    ///
    /// # Parameters
    ///
    /// * `_codec` - The codec reporting the value; it is not inspected or
    ///   mutated.
    /// * `_context` - The rejected value and progress, unused by this fixed
    ///   policy.
    ///
    /// # Returns
    ///
    /// Always returns `Ok(EncodeUnencodableAction::Reject)` without side
    /// effects.
    ///
    /// # Errors
    ///
    /// This policy never returns an error directly; the engine applies
    /// rejection.
    #[inline]
    fn handle_unencodable_encode(
        &mut self,
        _codec: &mut C,
        _context: &EncodeContext<'_, C::Value>,
    ) -> Result<EncodeUnencodableAction<C::Value>, TranscodeEncodeErrorOf<C>> {
        Ok(EncodeUnencodableAction::Reject)
    }
}