qubit-codec-binary 0.9.1

Buffer-oriented binary codecs for Rust
Documentation
// =============================================================================
//    Copyright (c) 2026 Haixing Hu.
//
//    SPDX-License-Identifier: Apache-2.0
//
//    Licensed under the Apache License, Version 2.0.
// =============================================================================

use super::Leb128DecodePolicy;

/// Selects LEB128 decoding that accepts non-canonical integer encodings.
///
/// Use this zero-sized policy as the second type parameter of
/// [`crate::Leb128Codec`] or [`crate::ZigZagCodec`] when decoding
/// compatibility-sensitive input. Encoding remains canonical regardless of the
/// selected policy. Non-canonical representations are accepted only within the
/// target integer's maximum decode width
/// ([`crate::Leb128Codec::MAX_DECODE_UNITS_PER_VALUE`]). The terminal payload
/// must still fit the target bit width. Over-width payloads and sequences that
/// remain unterminated at that maximum width are malformed; this policy does
/// not accept arbitrarily long encodings.
///
/// # Examples
///
/// ```
/// use qubit_codec_binary::{Leb128Codec, NonStrict};
///
/// let input = [0x80, 0x00];
/// let (value, consumed) = unsafe {
///     Leb128Codec::<u16, NonStrict>::decode(&input, 0)
/// }
/// .expect("non-canonical zero should decode with the non-strict policy");
/// assert_eq!(0, value);
/// assert_eq!(2, consumed.get());
/// ```
///
/// ```
/// use qubit_codec_binary::Leb128Codec;
/// use qubit_codec_binary::Leb128DecodeErrorKind;
/// use qubit_codec_binary::NonStrict;
///
/// let input = [0x80, 0x80, 0x00];
/// // SAFETY: The non-empty array provides the required first readable byte.
/// let error = unsafe { Leb128Codec::<u8, NonStrict>::decode(&input, 0) }
///     .expect_err("three bytes exceed the u8 decode width");
/// assert_eq!(Leb128DecodeErrorKind::Malformed, error.kind());
///
/// // SAFETY: The same array satisfies the decoder's readable-byte precondition.
/// let (value, consumed) = unsafe {
///     Leb128Codec::<u16, NonStrict>::decode(&input, 0)
/// }
/// .expect("the redundant zero fits the u16 decode width");
/// assert_eq!(0, value);
/// assert_eq!(3, consumed.get());
/// ```
#[derive(Clone, Copy, Debug, Default, Eq, PartialEq)]
pub struct NonStrict;

impl super::internal::sealed::Sealed for NonStrict {}

impl Leb128DecodePolicy for NonStrict {
    /// Whether this policy rejects non-canonical encodings.
    const STRICT: bool = false;
}