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

// =============================================================================
//    Copyright (c) 2026 Haixing Hu.
//
//    SPDX-License-Identifier: Apache-2.0
//
//    Licensed under the Apache License, Version 2.0.
// =============================================================================
//! Semantic marker trait for buffered decoders.

use super::TranscodeDecodeError;
use super::Transcoder;

/// Decodes encoded units into logical values over caller-provided buffers.
///
/// `TranscodeDecoder` refines [`Transcoder`] for implementations whose
/// input is the encoded unit stream and whose output is the logical value
/// stream. The trait adds no methods; it exists to make generic bounds
/// distinguish decoding direction from encoding and unit-to-unit conversion.
///
/// The word "buffered" describes the caller-managed buffer and progress model.
/// It does not require the implementor to own an internal buffer.
///
/// # Examples
///
/// ```
/// use qubit_codec::TranscodeDecoder;
///
/// fn accepts_decoder<D: TranscodeDecoder>(decoder: &D) {
///     let _ = decoder;
/// }
/// ```
pub trait TranscodeDecoder: Transcoder<Error = TranscodeDecodeError<Self::DecodeError>> {
    /// Domain error type produced by decode internals.
    type DecodeError;
}