19989385183

Committed 06 Dec 2025 01:47PM UTC coverage: 52.909% (+0.09%) from 52.821%

Build # 19989385183

Build Type

push

github

Committed by

vigna

Commit Message

Converted code enum variants to tuple types to increase readability

Run Details

19 of 357 new or added lines in 4 files covered. (5.32%)

9 existing lines in 3 files now uncovered.

1910 of 3610 relevant lines covered (52.91%)

3013506.24 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

22.76

/src/dispatch/codes.rs

/*
 * SPDX-FileCopyrightText: 2025 Tommaso Fontana
 * SPDX-FileCopyrightText: 2025 Inria
 * SPDX-FileCopyrightText: 2025 Sebastiano Vigna
 *
 * SPDX-License-Identifier: Apache-2.0 OR LGPL-2.1-or-later
 */

//! Enumeration of all available codes, with associated read and write methods.
//!
//! This is the slower and more generic form of dispatching, mostly used for
//! testing and writing examples. For faster dispatching, consider using
//! [dynamic] or [static] dispatch.

use super::*;
#[cfg(feature = "mem_dbg")]
use mem_dbg::{MemDbg, MemSize};

#[derive(Debug, Clone, Copy, Eq)]
#[cfg_attr(feature = "mem_dbg", derive(MemDbg, MemSize))]
#[cfg_attr(feature = "fuzz", derive(arbitrary::Arbitrary))]
#[non_exhaustive]
/// An enum whose variants represent all the available codes.
///
/// This enum is kept in sync with implementations in the
/// [`codes`](crate::codes) module.
///
/// Both [`Display`](std::fmt::Display) and [`FromStr`](std::str::FromStr) are
/// implemented for this enum in a dual way, which makes it possible to store a
/// code as a string in a configuration file, and then parse it back.
pub enum Codes {
    Unary,
    Gamma,
    Delta,
    Omega,
    VByteLe,
    VByteBe,
    Zeta(usize),
    Pi(usize),
    Golomb(u64),
    ExpGolomb(usize),
    Rice(usize),
}

/// Some codes are equivalent, so we implement [`PartialEq`] to make them
/// interchangeable so `Codes::Unary == Codes::Rice(0)`.
impl PartialEq for Codes {
    fn eq(&self, other: &Self) -> bool {
        match (self, other) {
            // First we check the equivalence classes
            (
                Self::Unary | Self::Rice(0) | Self::Golomb(1),
                Self::Unary | Self::Rice(0) | Self::Golomb(1),
            ) => true,
            (
                Self::Gamma | Self::Zeta(1) | Self::ExpGolomb(0),
                Self::Gamma | Self::Zeta(1) | Self::ExpGolomb(0),
            ) => true,
            (Self::Golomb(2) | Self::Rice(1), Self::Golomb(2) | Self::Rice(1)) => true,
            (Self::Golomb(4) | Self::Rice(2), Self::Golomb(4) | Self::Rice(2)) => true,
            (Self::Golomb(8) | Self::Rice(3), Self::Golomb(8) | Self::Rice(3)) => true,
            // we know that we are not in a special case, so we can directly
            // compare them naively
            (Self::Delta, Self::Delta) => true,
            (Self::Omega, Self::Omega) => true,
            (Self::VByteLe, Self::VByteLe) => true,
            (Self::VByteBe, Self::VByteBe) => true,
            (Self::Zeta(k), Self::Zeta(k2)) => k == k2,
            (Self::Pi(k), Self::Pi(k2)) => k == k2,
            (Self::Golomb(b), Self::Golomb(b2)) => b == b2,
            (Self::ExpGolomb(k), Self::ExpGolomb(k2)) => k == k2,
            (Self::Rice(log2_b), Self::Rice(log2_b2)) => log2_b == log2_b2,
            _ => false,
        }
    }
}

impl Codes {
    /// Delegate to the [`DynamicCodeRead`] implementation.
    ///
    /// This inherent method is provided to reduce ambiguity in method
    /// resolution.
    #[inline(always)]
    pub fn read<E: Endianness, CR: CodesRead<E> + ?Sized>(
        &self,
        reader: &mut CR,
    ) -> Result<u64, CR::Error> {
        DynamicCodeRead::read(self, reader)
    }

    /// Delegate to the [`DynamicCodeWrite`] implementation.
    ///
    /// This inherent method is provided to reduce ambiguity in method
    /// resolution.
    #[inline(always)]
    pub fn write<E: Endianness, CW: CodesWrite<E> + ?Sized>(
        &self,
        writer: &mut CW,
        value: u64,
    ) -> Result<usize, CW::Error> {
        DynamicCodeWrite::write(self, writer, value)
    }

    /// Convert a code to the constant enum [`code_consts`] used for [`ConstCode`].
    /// This is mostly used to verify that the code is supported by
    /// [`ConstCode`].
    pub fn to_code_const(&self) -> Result<usize> {
        Ok(match self {
            Self::Unary => code_consts::UNARY,
            Self::Gamma => code_consts::GAMMA,
            Self::Delta => code_consts::DELTA,
            Self::Omega => code_consts::OMEGA,
            Self::VByteLe => code_consts::VBYTE_LE,
            Self::VByteBe => code_consts::VBYTE_BE,
            Self::Zeta(1) => code_consts::ZETA1,
            Self::Zeta(2) => code_consts::ZETA2,
            Self::Zeta(3) => code_consts::ZETA3,
            Self::Zeta(4) => code_consts::ZETA4,
            Self::Zeta(5) => code_consts::ZETA5,
            Self::Zeta(6) => code_consts::ZETA6,
            Self::Zeta(7) => code_consts::ZETA7,
            Self::Zeta(8) => code_consts::ZETA8,
            Self::Zeta(9) => code_consts::ZETA9,
            Self::Zeta(10) => code_consts::ZETA10,
            Self::Rice(0) => code_consts::RICE0,
            Self::Rice(1) => code_consts::RICE1,
            Self::Rice(2) => code_consts::RICE2,
            Self::Rice(3) => code_consts::RICE3,
            Self::Rice(4) => code_consts::RICE4,
            Self::Rice(5) => code_consts::RICE5,
            Self::Rice(6) => code_consts::RICE6,
            Self::Rice(7) => code_consts::RICE7,
            Self::Rice(8) => code_consts::RICE8,
            Self::Rice(9) => code_consts::RICE9,
            Self::Rice(10) => code_consts::RICE10,
            Self::Pi(0) => code_consts::PI0,
            Self::Pi(1) => code_consts::PI1,
            Self::Pi(2) => code_consts::PI2,
            Self::Pi(3) => code_consts::PI3,
            Self::Pi(4) => code_consts::PI4,
            Self::Pi(5) => code_consts::PI5,
            Self::Pi(6) => code_consts::PI6,
            Self::Pi(7) => code_consts::PI7,
            Self::Pi(8) => code_consts::PI8,
            Self::Pi(9) => code_consts::PI9,
            Self::Pi(10) => code_consts::PI10,
            Self::Golomb(1) => code_consts::GOLOMB1,
            Self::Golomb(2) => code_consts::GOLOMB2,
            Self::Golomb(3) => code_consts::GOLOMB3,
            Self::Golomb(4) => code_consts::GOLOMB4,
            Self::Golomb(5) => code_consts::GOLOMB5,
            Self::Golomb(6) => code_consts::GOLOMB6,
            Self::Golomb(7) => code_consts::GOLOMB7,
            Self::Golomb(8) => code_consts::GOLOMB8,
            Self::Golomb(9) => code_consts::GOLOMB9,
            Self::Golomb(10) => code_consts::GOLOMB10,
            Self::ExpGolomb(0) => code_consts::EXP_GOLOMB0,
            Self::ExpGolomb(1) => code_consts::EXP_GOLOMB1,
            Self::ExpGolomb(2) => code_consts::EXP_GOLOMB2,
            Self::ExpGolomb(3) => code_consts::EXP_GOLOMB3,
            Self::ExpGolomb(4) => code_consts::EXP_GOLOMB4,
            Self::ExpGolomb(5) => code_consts::EXP_GOLOMB5,
            Self::ExpGolomb(6) => code_consts::EXP_GOLOMB6,
            Self::ExpGolomb(7) => code_consts::EXP_GOLOMB7,
            Self::ExpGolomb(8) => code_consts::EXP_GOLOMB8,
            Self::ExpGolomb(9) => code_consts::EXP_GOLOMB9,
            Self::ExpGolomb(10) => code_consts::EXP_GOLOMB10,
            _ => {
                return Err(anyhow::anyhow!(
                    "Code {:?} not supported as const code",
                    self
                ));
            }
        })
    }

    /// Convert a value from [`code_consts`] to a code.
    pub fn from_code_const(const_code: usize) -> Result<Self> {
        Ok(match const_code {
            code_consts::UNARY => Self::Unary,
            code_consts::GAMMA => Self::Gamma,
            code_consts::DELTA => Self::Delta,
            code_consts::OMEGA => Self::Omega,
            code_consts::VBYTE_LE => Self::VByteLe,
            code_consts::VBYTE_BE => Self::VByteBe,
            code_consts::ZETA2 => Self::Zeta(2),
            code_consts::ZETA3 => Self::Zeta(3),
            code_consts::ZETA4 => Self::Zeta(4),
            code_consts::ZETA5 => Self::Zeta(5),
            code_consts::ZETA6 => Self::Zeta(6),
            code_consts::ZETA7 => Self::Zeta(7),
            code_consts::ZETA8 => Self::Zeta(8),
            code_consts::ZETA9 => Self::Zeta(9),
            code_consts::ZETA10 => Self::Zeta(10),
            code_consts::RICE1 => Self::Rice(1),
            code_consts::RICE2 => Self::Rice(2),
            code_consts::RICE3 => Self::Rice(3),
            code_consts::RICE4 => Self::Rice(4),
            code_consts::RICE5 => Self::Rice(5),
            code_consts::RICE6 => Self::Rice(6),
            code_consts::RICE7 => Self::Rice(7),
            code_consts::RICE8 => Self::Rice(8),
            code_consts::RICE9 => Self::Rice(9),
            code_consts::RICE10 => Self::Rice(10),
            code_consts::PI1 => Self::Pi(1),
            code_consts::PI2 => Self::Pi(2),
            code_consts::PI3 => Self::Pi(3),
            code_consts::PI4 => Self::Pi(4),
            code_consts::PI5 => Self::Pi(5),
            code_consts::PI6 => Self::Pi(6),
            code_consts::PI7 => Self::Pi(7),
            code_consts::PI8 => Self::Pi(8),
            code_consts::PI9 => Self::Pi(9),
            code_consts::PI10 => Self::Pi(10),
            code_consts::GOLOMB3 => Self::Golomb(3),
            code_consts::GOLOMB5 => Self::Golomb(5),
            code_consts::GOLOMB6 => Self::Golomb(6),
            code_consts::GOLOMB7 => Self::Golomb(7),
            code_consts::GOLOMB9 => Self::Golomb(9),
            code_consts::GOLOMB10 => Self::Golomb(10),
            code_consts::EXP_GOLOMB1 => Self::ExpGolomb(1),
            code_consts::EXP_GOLOMB2 => Self::ExpGolomb(2),
            code_consts::EXP_GOLOMB3 => Self::ExpGolomb(3),
            code_consts::EXP_GOLOMB4 => Self::ExpGolomb(4),
            code_consts::EXP_GOLOMB5 => Self::ExpGolomb(5),
            code_consts::EXP_GOLOMB6 => Self::ExpGolomb(6),
            code_consts::EXP_GOLOMB7 => Self::ExpGolomb(7),
            code_consts::EXP_GOLOMB8 => Self::ExpGolomb(8),
            code_consts::EXP_GOLOMB9 => Self::ExpGolomb(9),
            code_consts::EXP_GOLOMB10 => Self::ExpGolomb(10),
            _ => return Err(anyhow::anyhow!("Code {} not supported", const_code)),
        })
    }
}

impl DynamicCodeRead for Codes {
    #[inline]
    fn read<E: Endianness, CR: CodesRead<E> + ?Sized>(
        &self,
        reader: &mut CR,
    ) -> Result<u64, CR::Error> {
        Ok(match self {
            Codes::Unary => reader.read_unary()?,
            Codes::Gamma => reader.read_gamma()?,
            Codes::Delta => reader.read_delta()?,
            Codes::Omega => reader.read_omega()?,
            Codes::VByteBe => reader.read_vbyte_be()?,
            Codes::VByteLe => reader.read_vbyte_le()?,
            Codes::Zeta(3) => reader.read_zeta3()?,
            Codes::Zeta(k) => reader.read_zeta(*k)?,
            Codes::Pi(k) => reader.read_pi(*k)?,
            Codes::Golomb(b) => reader.read_golomb(*b)?,
            Codes::ExpGolomb(k) => reader.read_exp_golomb(*k)?,
            Codes::Rice(log2_b) => reader.read_rice(*log2_b)?,
        })
    }
}

impl DynamicCodeWrite for Codes {
    #[inline]
    fn write<E: Endianness, CW: CodesWrite<E> + ?Sized>(
        &self,
        writer: &mut CW,
        value: u64,
    ) -> Result<usize, CW::Error> {
        Ok(match self {
            Codes::Unary => writer.write_unary(value)?,
            Codes::Gamma => writer.write_gamma(value)?,
            Codes::Delta => writer.write_delta(value)?,
            Codes::Omega => writer.write_omega(value)?,
            Codes::VByteBe => writer.write_vbyte_be(value)?,
            Codes::VByteLe => writer.write_vbyte_le(value)?,
            Codes::Zeta(1) => writer.write_gamma(value)?,
            Codes::Zeta(3) => writer.write_zeta3(value)?,
            Codes::Zeta(k) => writer.write_zeta(value, *k)?,
            Codes::Pi(k) => writer.write_pi(value, *k)?,
            Codes::Golomb(b) => writer.write_golomb(value, *b)?,
            Codes::ExpGolomb(k) => writer.write_exp_golomb(value, *k)?,
            Codes::Rice(log2_b) => writer.write_rice(value, *log2_b)?,
        })
    }
}

impl<E: Endianness, CR: CodesRead<E> + ?Sized> StaticCodeRead<E, CR> for Codes {
    #[inline(always)]
    fn read(&self, reader: &mut CR) -> Result<u64, CR::Error> {
        <Self as DynamicCodeRead>::read(self, reader)
    }
}

impl<E: Endianness, CW: CodesWrite<E> + ?Sized> StaticCodeWrite<E, CW> for Codes {
    #[inline(always)]
    fn write(&self, writer: &mut CW, value: u64) -> Result<usize, CW::Error> {
        <Self as DynamicCodeWrite>::write(self, writer, value)
    }
}

impl CodeLen for Codes {
    #[inline]
    fn len(&self, value: u64) -> usize {
        match self {
            Codes::Unary => value as usize + 1,
            Codes::Gamma => len_gamma(value),
            Codes::Delta => len_delta(value),
            Codes::Omega => len_omega(value),
            Codes::VByteLe | Codes::VByteBe => bit_len_vbyte(value),
            Codes::Zeta(1) => len_gamma(value),
            Codes::Zeta(k) => len_zeta(value, *k),
            Codes::Pi(k) => len_pi(value, *k),
            Codes::Golomb(b) => len_golomb(value, *b),
            Codes::ExpGolomb(k) => len_exp_golomb(value, *k),
            Codes::Rice(log2_b) => len_rice(value, *log2_b),
        }
    }
}

#[derive(Debug)]
/// Error type for parsing a code from a string.
pub enum CodeError {
    ParseError(core::num::ParseIntError),
    UnknownCode([u8; 32]),
}
#[cfg(feature = "std")]
impl std::error::Error for CodeError {}
impl core::fmt::Display for CodeError {
    fn fmt(&self, f: &mut core::fmt::Formatter) -> core::fmt::Result {
        match self {
            CodeError::ParseError(e) => write!(f, "Parse error: {}", e),
            CodeError::UnknownCode(s) => {
                write!(f, "Unknown code: ")?;
                for c in s {
                    if *c == 0 {
                        break;
                    }
                    write!(f, "{}", *c as char)?;
                }
                Ok(())
            }
        }
    }
}

impl From<core::num::ParseIntError> for CodeError {
    fn from(e: core::num::ParseIntError) -> Self {
        CodeError::ParseError(e)
    }
}

impl core::fmt::Display for Codes {
    fn fmt(&self, f: &mut core::fmt::Formatter) -> core::fmt::Result {
        match self {
            Codes::Unary => write!(f, "Unary"),
            Codes::Gamma => write!(f, "Gamma"),
            Codes::Delta => write!(f, "Delta"),
            Codes::Omega => write!(f, "Omega"),
            Codes::VByteBe => write!(f, "VByteBe"),
            Codes::VByteLe => write!(f, "VByteLe"),
            Codes::Zeta(k) => write!(f, "Zeta({})", k),
            Codes::Pi(k) => write!(f, "Pi({})", k),
            Codes::Golomb(b) => write!(f, "Golomb({})", b),
            Codes::ExpGolomb(k) => write!(f, "ExpGolomb({})", k),
            Codes::Rice(log2_b) => write!(f, "Rice({})", log2_b),
        }
    }
}

fn array_format_error(s: &str) -> [u8; 32] {
    let mut error_buffer = [0u8; 32];
    const ERROR_PREFIX: &[u8] = b"Could not parse ";
    error_buffer[..ERROR_PREFIX.len()].copy_from_slice(ERROR_PREFIX);
    error_buffer[ERROR_PREFIX.len()..ERROR_PREFIX.len() + s.len().min(32 - ERROR_PREFIX.len())]
        .copy_from_slice(&s.as_bytes()[..s.len().min(32 - ERROR_PREFIX.len())]);
    error_buffer
}

impl core::str::FromStr for Codes {
    type Err = CodeError;

    fn from_str(s: &str) -> Result<Self, Self::Err> {
        match s {
            "Unary" => Ok(Codes::Unary),
            "Gamma" => Ok(Codes::Gamma),
            "Delta" => Ok(Codes::Delta),
            "Omega" => Ok(Codes::Omega),
            "VByteBe" => Ok(Codes::VByteBe),

            _ => {
                let mut parts = s.split('(');
                let name = parts
                    .next()
                    .ok_or_else(|| CodeError::UnknownCode(array_format_error(s)))?;
                let k = parts
                    .next()
                    .ok_or_else(|| CodeError::UnknownCode(array_format_error(s)))?
                    .split(')')
                    .next()
                    .ok_or_else(|| CodeError::UnknownCode(array_format_error(s)))?;
                match name {
                    "Zeta" => Ok(Codes::Zeta(k.parse()?)),
                    "Pi" => Ok(Codes::Pi(k.parse()?)),
                    "Golomb" => Ok(Codes::Golomb(k.parse()?)),
                    "ExpGolomb" => Ok(Codes::ExpGolomb(k.parse()?)),
                    "Rice" => Ok(Codes::Rice(k.parse()?)),
                    _ => Err(CodeError::UnknownCode(array_format_error(name))),
                }
            }
        }
    }
}

/// Structure representing minimal binary coding with a fixed length.
///
/// [Minimal binary coding](crate::codes::minimal_binary) does not
/// fit the [`Codes`] enum because it is not defined for all integers.
///
/// Instances of this structure can be used in context in which a
/// [`DynamicCodeRead`], [`DynamicCodeWrite`], [`StaticCodeRead`],
/// [`StaticCodeWrite`] or [`CodeLen`] implementing minimal binary coding
/// is necessary.
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub struct MinimalBinary(pub u64);

impl DynamicCodeRead for MinimalBinary {
    fn read<E: Endianness, R: CodesRead<E> + ?Sized>(
        &self,
        reader: &mut R,
    ) -> Result<u64, R::Error> {
        reader.read_minimal_binary(self.0)
    }
}

impl DynamicCodeWrite for MinimalBinary {
    fn write<E: Endianness, W: CodesWrite<E> + ?Sized>(
        &self,
        writer: &mut W,
        n: u64,
    ) -> Result<usize, W::Error> {
        writer.write_minimal_binary(n, self.0)
    }
}

impl<E: Endianness, CR: CodesRead<E> + ?Sized> StaticCodeRead<E, CR> for MinimalBinary {
    fn read(&self, reader: &mut CR) -> Result<u64, CR::Error> {
        <Self as DynamicCodeRead>::read(self, reader)
    }
}

impl<E: Endianness, CW: CodesWrite<E> + ?Sized> StaticCodeWrite<E, CW> for MinimalBinary {
    fn write(&self, writer: &mut CW, n: u64) -> Result<usize, CW::Error> {
        <Self as DynamicCodeWrite>::write(self, writer, n)
    }
}

impl CodeLen for MinimalBinary {
    fn len(&self, n: u64) -> usize {
        len_minimal_binary(n, self.0)
    }
}

1	/*
2	* SPDX-FileCopyrightText: 2025 Tommaso Fontana
3	* SPDX-FileCopyrightText: 2025 Inria
4	* SPDX-FileCopyrightText: 2025 Sebastiano Vigna
5	*
6	* SPDX-License-Identifier: Apache-2.0 OR LGPL-2.1-or-later
7	*/
8
9	//! Enumeration of all available codes, with associated read and write methods.
10	//!
11	//! This is the slower and more generic form of dispatching, mostly used for
12	//! testing and writing examples. For faster dispatching, consider using
13	//! [dynamic] or [static] dispatch.
14
15	use super::*;
16	#[cfg(feature = "mem_dbg")]
17	use mem_dbg::{MemDbg, MemSize};
18
19	#[derive(Debug, Clone, Copy, Eq)]
20	#[cfg_attr(feature = "mem_dbg", derive(MemDbg, MemSize))]
21	#[cfg_attr(feature = "fuzz", derive(arbitrary::Arbitrary))]
22	#[non_exhaustive]
23	/// An enum whose variants represent all the available codes.
24	///
25	/// This enum is kept in sync with implementations in the
26	/// [`codes`](crate::codes) module.
27	///
28	/// Both [`Display`](std::fmt::Display) and [`FromStr`](std::str::FromStr) are
29	/// implemented for this enum in a dual way, which makes it possible to store a
30	/// code as a string in a configuration file, and then parse it back.
31	pub enum Codes {
32	Unary,
33	Gamma,
34	Delta,
35	Omega,
36	VByteLe,
37	VByteBe,
38	Zeta(usize),
39	Pi(usize),
40	Golomb(u64),
41	ExpGolomb(usize),
42	Rice(usize),
43	}
44
45	/// Some codes are equivalent, so we implement [`PartialEq`] to make them
46	/// interchangeable so `Codes::Unary == Codes::Rice(0)`.
47	impl PartialEq for Codes {
48	fn eq(&self, other: &Self) -> bool {	×
49	match (self, other) {	×
50	// First we check the equivalence classes
51	(
52	Self::Unary \| Self::Rice(0) \| Self::Golomb(1),
53	Self::Unary \| Self::Rice(0) \| Self::Golomb(1),
UNCOV 54	) => true,	×
55	(
56	Self::Gamma \| Self::Zeta(1) \| Self::ExpGolomb(0),
57	Self::Gamma \| Self::Zeta(1) \| Self::ExpGolomb(0),
UNCOV 58	) => true,	×
NEW 59	(Self::Golomb(2) \| Self::Rice(1), Self::Golomb(2) \| Self::Rice(1)) => true,	×
NEW 60	(Self::Golomb(4) \| Self::Rice(2), Self::Golomb(4) \| Self::Rice(2)) => true,	×
NEW 61	(Self::Golomb(8) \| Self::Rice(3), Self::Golomb(8) \| Self::Rice(3)) => true,	×
62	// we know that we are not in a special case, so we can directly
63	// compare them naively
64	(Self::Delta, Self::Delta) => true,	×
65	(Self::Omega, Self::Omega) => true,	×
66	(Self::VByteLe, Self::VByteLe) => true,	×
67	(Self::VByteBe, Self::VByteBe) => true,	×
NEW 68	(Self::Zeta(k), Self::Zeta(k2)) => k == k2,	×
NEW 69	(Self::Pi(k), Self::Pi(k2)) => k == k2,	×
NEW 70	(Self::Golomb(b), Self::Golomb(b2)) => b == b2,	×
NEW 71	(Self::ExpGolomb(k), Self::ExpGolomb(k2)) => k == k2,	×
NEW 72	(Self::Rice(log2_b), Self::Rice(log2_b2)) => log2_b == log2_b2,	×
UNCOV 73	_ => false,	×
74	}
75	}
76	}
77
78	impl Codes {
79	/// Delegate to the [`DynamicCodeRead`] implementation.
80	///
81	/// This inherent method is provided to reduce ambiguity in method
82	/// resolution.
83	#[inline(always)]
84	pub fn read<E: Endianness, CR: CodesRead<E> + ?Sized>(	×
85	&self,
86	reader: &mut CR,
87	) -> Result<u64, CR::Error> {
88	DynamicCodeRead::read(self, reader)	×
89	}
90
91	/// Delegate to the [`DynamicCodeWrite`] implementation.
92	///
93	/// This inherent method is provided to reduce ambiguity in method
94	/// resolution.
95	#[inline(always)]
96	pub fn write<E: Endianness, CW: CodesWrite<E> + ?Sized>(	×
97	&self,
98	writer: &mut CW,
99	value: u64,
100	) -> Result<usize, CW::Error> {
101	DynamicCodeWrite::write(self, writer, value)	×
102	}
103
104	/// Convert a code to the constant enum [`code_consts`] used for [`ConstCode`].
105	/// This is mostly used to verify that the code is supported by
106	/// [`ConstCode`].
107	pub fn to_code_const(&self) -> Result<usize> {	×
108	Ok(match self {	×
109	Self::Unary => code_consts::UNARY,	×
110	Self::Gamma => code_consts::GAMMA,	×
111	Self::Delta => code_consts::DELTA,	×
112	Self::Omega => code_consts::OMEGA,	×
113	Self::VByteLe => code_consts::VBYTE_LE,	×
114	Self::VByteBe => code_consts::VBYTE_BE,	×
NEW 115	Self::Zeta(1) => code_consts::ZETA1,	×
NEW 116	Self::Zeta(2) => code_consts::ZETA2,	×
NEW 117	Self::Zeta(3) => code_consts::ZETA3,	×
NEW 118	Self::Zeta(4) => code_consts::ZETA4,	×
NEW 119	Self::Zeta(5) => code_consts::ZETA5,	×
NEW 120	Self::Zeta(6) => code_consts::ZETA6,	×
NEW 121	Self::Zeta(7) => code_consts::ZETA7,	×
NEW 122	Self::Zeta(8) => code_consts::ZETA8,	×
NEW 123	Self::Zeta(9) => code_consts::ZETA9,	×
NEW 124	Self::Zeta(10) => code_consts::ZETA10,	×
NEW 125	Self::Rice(0) => code_consts::RICE0,	×
NEW 126	Self::Rice(1) => code_consts::RICE1,	×
NEW 127	Self::Rice(2) => code_consts::RICE2,	×
NEW 128	Self::Rice(3) => code_consts::RICE3,	×
NEW 129	Self::Rice(4) => code_consts::RICE4,	×
NEW 130	Self::Rice(5) => code_consts::RICE5,	×
NEW 131	Self::Rice(6) => code_consts::RICE6,	×
NEW 132	Self::Rice(7) => code_consts::RICE7,	×
NEW 133	Self::Rice(8) => code_consts::RICE8,	×
NEW 134	Self::Rice(9) => code_consts::RICE9,	×
NEW 135	Self::Rice(10) => code_consts::RICE10,	×
NEW 136	Self::Pi(0) => code_consts::PI0,	×
NEW 137	Self::Pi(1) => code_consts::PI1,	×
NEW 138	Self::Pi(2) => code_consts::PI2,	×
NEW 139	Self::Pi(3) => code_consts::PI3,	×
NEW 140	Self::Pi(4) => code_consts::PI4,	×
NEW 141	Self::Pi(5) => code_consts::PI5,	×
NEW 142	Self::Pi(6) => code_consts::PI6,	×
NEW 143	Self::Pi(7) => code_consts::PI7,	×
NEW 144	Self::Pi(8) => code_consts::PI8,	×
NEW 145	Self::Pi(9) => code_consts::PI9,	×
NEW 146	Self::Pi(10) => code_consts::PI10,	×
NEW 147	Self::Golomb(1) => code_consts::GOLOMB1,	×
NEW 148	Self::Golomb(2) => code_consts::GOLOMB2,	×
NEW 149	Self::Golomb(3) => code_consts::GOLOMB3,	×
NEW 150	Self::Golomb(4) => code_consts::GOLOMB4,	×
NEW 151	Self::Golomb(5) => code_consts::GOLOMB5,	×
NEW 152	Self::Golomb(6) => code_consts::GOLOMB6,	×
NEW 153	Self::Golomb(7) => code_consts::GOLOMB7,	×
NEW 154	Self::Golomb(8) => code_consts::GOLOMB8,	×
NEW 155	Self::Golomb(9) => code_consts::GOLOMB9,	×
NEW 156	Self::Golomb(10) => code_consts::GOLOMB10,	×
NEW 157	Self::ExpGolomb(0) => code_consts::EXP_GOLOMB0,	×
NEW 158	Self::ExpGolomb(1) => code_consts::EXP_GOLOMB1,	×
NEW 159	Self::ExpGolomb(2) => code_consts::EXP_GOLOMB2,	×
NEW 160	Self::ExpGolomb(3) => code_consts::EXP_GOLOMB3,	×
NEW 161	Self::ExpGolomb(4) => code_consts::EXP_GOLOMB4,	×
NEW 162	Self::ExpGolomb(5) => code_consts::EXP_GOLOMB5,	×
NEW 163	Self::ExpGolomb(6) => code_consts::EXP_GOLOMB6,	×
NEW 164	Self::ExpGolomb(7) => code_consts::EXP_GOLOMB7,	×
NEW 165	Self::ExpGolomb(8) => code_consts::EXP_GOLOMB8,	×
NEW 166	Self::ExpGolomb(9) => code_consts::EXP_GOLOMB9,	×
NEW 167	Self::ExpGolomb(10) => code_consts::EXP_GOLOMB10,	×
168	_ => {
169	return Err(anyhow::anyhow!(	×
170	"Code {:?} not supported as const code",	×
171	self	×
172	));
173	}
174	})
175	}
176
177	/// Convert a value from [`code_consts`] to a code.
178	pub fn from_code_const(const_code: usize) -> Result<Self> {	×
179	Ok(match const_code {	×
180	code_consts::UNARY => Self::Unary,	×
181	code_consts::GAMMA => Self::Gamma,	×
182	code_consts::DELTA => Self::Delta,	×
183	code_consts::OMEGA => Self::Omega,	×
184	code_consts::VBYTE_LE => Self::VByteLe,	×
185	code_consts::VBYTE_BE => Self::VByteBe,	×
NEW 186	code_consts::ZETA2 => Self::Zeta(2),	×
NEW 187	code_consts::ZETA3 => Self::Zeta(3),	×
NEW 188	code_consts::ZETA4 => Self::Zeta(4),	×
NEW 189	code_consts::ZETA5 => Self::Zeta(5),	×
NEW 190	code_consts::ZETA6 => Self::Zeta(6),	×
NEW 191	code_consts::ZETA7 => Self::Zeta(7),	×
NEW 192	code_consts::ZETA8 => Self::Zeta(8),	×
NEW 193	code_consts::ZETA9 => Self::Zeta(9),	×
NEW 194	code_consts::ZETA10 => Self::Zeta(10),	×
NEW 195	code_consts::RICE1 => Self::Rice(1),	×
NEW 196	code_consts::RICE2 => Self::Rice(2),	×
NEW 197	code_consts::RICE3 => Self::Rice(3),	×
NEW 198	code_consts::RICE4 => Self::Rice(4),	×
NEW 199	code_consts::RICE5 => Self::Rice(5),	×
NEW 200	code_consts::RICE6 => Self::Rice(6),	×
NEW 201	code_consts::RICE7 => Self::Rice(7),	×
NEW 202	code_consts::RICE8 => Self::Rice(8),	×
NEW 203	code_consts::RICE9 => Self::Rice(9),	×
NEW 204	code_consts::RICE10 => Self::Rice(10),	×
NEW 205	code_consts::PI1 => Self::Pi(1),	×
NEW 206	code_consts::PI2 => Self::Pi(2),	×
NEW 207	code_consts::PI3 => Self::Pi(3),	×
NEW 208	code_consts::PI4 => Self::Pi(4),	×
NEW 209	code_consts::PI5 => Self::Pi(5),	×
NEW 210	code_consts::PI6 => Self::Pi(6),	×
NEW 211	code_consts::PI7 => Self::Pi(7),	×
NEW 212	code_consts::PI8 => Self::Pi(8),	×
NEW 213	code_consts::PI9 => Self::Pi(9),	×
NEW 214	code_consts::PI10 => Self::Pi(10),	×
NEW 215	code_consts::GOLOMB3 => Self::Golomb(3),	×
NEW 216	code_consts::GOLOMB5 => Self::Golomb(5),	×
NEW 217	code_consts::GOLOMB6 => Self::Golomb(6),	×
NEW 218	code_consts::GOLOMB7 => Self::Golomb(7),	×
NEW 219	code_consts::GOLOMB9 => Self::Golomb(9),	×
NEW 220	code_consts::GOLOMB10 => Self::Golomb(10),	×
NEW 221	code_consts::EXP_GOLOMB1 => Self::ExpGolomb(1),	×
NEW 222	code_consts::EXP_GOLOMB2 => Self::ExpGolomb(2),	×
NEW 223	code_consts::EXP_GOLOMB3 => Self::ExpGolomb(3),	×
NEW 224	code_consts::EXP_GOLOMB4 => Self::ExpGolomb(4),	×
NEW 225	code_consts::EXP_GOLOMB5 => Self::ExpGolomb(5),	×
NEW 226	code_consts::EXP_GOLOMB6 => Self::ExpGolomb(6),	×
NEW 227	code_consts::EXP_GOLOMB7 => Self::ExpGolomb(7),	×
NEW 228	code_consts::EXP_GOLOMB8 => Self::ExpGolomb(8),	×
NEW 229	code_consts::EXP_GOLOMB9 => Self::ExpGolomb(9),	×
NEW 230	code_consts::EXP_GOLOMB10 => Self::ExpGolomb(10),	×
UNCOV 231	_ => return Err(anyhow::anyhow!("Code {} not supported", const_code)),	×
232	})
233	}
234	}
235
236	impl DynamicCodeRead for Codes {
237	#[inline]
238	fn read<E: Endianness, CR: CodesRead<E> + ?Sized>(	230,064✔
239	&self,
240	reader: &mut CR,
241	) -> Result<u64, CR::Error> {
242	Ok(match self {	230,064✔
243	Codes::Unary => reader.read_unary()?,	8,192✔
244	Codes::Gamma => reader.read_gamma()?,	8,712✔
245	Codes::Delta => reader.read_delta()?,	8,712✔
246	Codes::Omega => reader.read_omega()?,	8,712✔
247	Codes::VByteBe => reader.read_vbyte_be()?,	8,720✔
248	Codes::VByteLe => reader.read_vbyte_le()?,	8,720✔
249	Codes::Zeta(3) => reader.read_zeta3()?,	8,712✔
250	Codes::Zeta(k) => reader.read_zeta(*k)?,	139,392✔
251	Codes::Pi(k) => reader.read_pi(*k)?,	174,240✔
252	Codes::Golomb(b) => reader.read_golomb(*b)?,	147,504✔
253	Codes::ExpGolomb(k) => reader.read_exp_golomb(*k)?,	174,272✔
254	Codes::Rice(log2_b) => reader.read_rice(*log2_b)?,	163,888✔
255	})
256	}
257	}
258
259	impl DynamicCodeWrite for Codes {
260	#[inline]
261	fn write<E: Endianness, CW: CodesWrite<E> + ?Sized>(	230,064✔
262	&self,
263	writer: &mut CW,
264	value: u64,
265	) -> Result<usize, CW::Error> {
266	Ok(match self {	230,064✔
267	Codes::Unary => writer.write_unary(value)?,	12,288✔
268	Codes::Gamma => writer.write_gamma(value)?,	13,068✔
269	Codes::Delta => writer.write_delta(value)?,	13,068✔
270	Codes::Omega => writer.write_omega(value)?,	13,068✔
271	Codes::VByteBe => writer.write_vbyte_be(value)?,	13,080✔
272	Codes::VByteLe => writer.write_vbyte_le(value)?,	13,080✔
273	Codes::Zeta(1) => writer.write_gamma(value)?,	13,068✔
274	Codes::Zeta(3) => writer.write_zeta3(value)?,	13,068✔
275	Codes::Zeta(k) => writer.write_zeta(value, *k)?,	152,460✔
276	Codes::Pi(k) => writer.write_pi(value, *k)?,	217,800✔
277	Codes::Golomb(b) => writer.write_golomb(value, *b)?,	184,380✔
278	Codes::ExpGolomb(k) => writer.write_exp_golomb(value, *k)?,	217,840✔
279	Codes::Rice(log2_b) => writer.write_rice(value, *log2_b)?,	204,860✔
280	})
281	}
282	}
283
284	impl<E: Endianness, CR: CodesRead<E> + ?Sized> StaticCodeRead<E, CR> for Codes {
285	#[inline(always)]
286	fn read(&self, reader: &mut CR) -> Result<u64, CR::Error> {	115,032✔
287	<Self as DynamicCodeRead>::read(self, reader)	345,096✔
288	}
289	}
290
291	impl<E: Endianness, CW: CodesWrite<E> + ?Sized> StaticCodeWrite<E, CW> for Codes {
292	#[inline(always)]
293	fn write(&self, writer: &mut CW, value: u64) -> Result<usize, CW::Error> {	115,032✔
294	<Self as DynamicCodeWrite>::write(self, writer, value)	460,128✔
295	}
296	}
297
298	impl CodeLen for Codes {
299	#[inline]
300	fn len(&self, value: u64) -> usize {	230,064✔
301	match self {	230,064✔
302	Codes::Unary => value as usize + 1,	4,096✔
303	Codes::Gamma => len_gamma(value),	8,712✔
304	Codes::Delta => len_delta(value),	8,712✔
305	Codes::Omega => len_omega(value),	8,712✔
306	Codes::VByteLe \| Codes::VByteBe => bit_len_vbyte(value),	17,440✔
307	Codes::Zeta(1) => len_gamma(value),	8,712✔
308	Codes::Zeta(k) => len_zeta(value, *k),	139,392✔
309	Codes::Pi(k) => len_pi(value, *k),	174,240✔
310	Codes::Golomb(b) => len_golomb(value, *b),	147,504✔
311	Codes::ExpGolomb(k) => len_exp_golomb(value, *k),	174,272✔
312	Codes::Rice(log2_b) => len_rice(value, *log2_b),	163,888✔
313	}
314	}
315	}
316
317	#[derive(Debug)]
318	/// Error type for parsing a code from a string.
319	pub enum CodeError {
320	ParseError(core::num::ParseIntError),
321	UnknownCode([u8; 32]),
322	}
323	#[cfg(feature = "std")]
324	impl std::error::Error for CodeError {}
325	impl core::fmt::Display for CodeError {
326	fn fmt(&self, f: &mut core::fmt::Formatter) -> core::fmt::Result {	×
327	match self {	×
328	CodeError::ParseError(e) => write!(f, "Parse error: {}", e),	×
329	CodeError::UnknownCode(s) => {	×
330	write!(f, "Unknown code: ")?;	×
331	for c in s {	×
332	if *c == 0 {	×
333	break;	×
334	}
335	write!(f, "{}", *c as char)?;	×
336	}
337	Ok(())	×
338	}
339	}
340	}
341	}
342
343	impl From<core::num::ParseIntError> for CodeError {
344	fn from(e: core::num::ParseIntError) -> Self {	×
345	CodeError::ParseError(e)	×
346	}
347	}
348
349	impl core::fmt::Display for Codes {
350	fn fmt(&self, f: &mut core::fmt::Formatter) -> core::fmt::Result {	×
351	match self {	×
352	Codes::Unary => write!(f, "Unary"),	×
353	Codes::Gamma => write!(f, "Gamma"),	×
354	Codes::Delta => write!(f, "Delta"),	×
355	Codes::Omega => write!(f, "Omega"),	×
356	Codes::VByteBe => write!(f, "VByteBe"),	×
357	Codes::VByteLe => write!(f, "VByteLe"),	×
NEW 358	Codes::Zeta(k) => write!(f, "Zeta({})", k),	×
NEW 359	Codes::Pi(k) => write!(f, "Pi({})", k),	×
NEW 360	Codes::Golomb(b) => write!(f, "Golomb({})", b),	×
NEW 361	Codes::ExpGolomb(k) => write!(f, "ExpGolomb({})", k),	×
NEW 362	Codes::Rice(log2_b) => write!(f, "Rice({})", log2_b),	×
363	}
364	}
365	}
366
367	fn array_format_error(s: &str) -> [u8; 32] {	×
368	let mut error_buffer = [0u8; 32];	×
369	const ERROR_PREFIX: &[u8] = b"Could not parse ";
370	error_buffer[..ERROR_PREFIX.len()].copy_from_slice(ERROR_PREFIX);	×
371	error_buffer[ERROR_PREFIX.len()..ERROR_PREFIX.len() + s.len().min(32 - ERROR_PREFIX.len())]	×
372	.copy_from_slice(&s.as_bytes()[..s.len().min(32 - ERROR_PREFIX.len())]);	×
373	error_buffer	×
374	}
375
376	impl core::str::FromStr for Codes {
377	type Err = CodeError;
378
379	fn from_str(s: &str) -> Result<Self, Self::Err> {	×
380	match s {	×
381	"Unary" => Ok(Codes::Unary),	×
382	"Gamma" => Ok(Codes::Gamma),	×
383	"Delta" => Ok(Codes::Delta),	×
384	"Omega" => Ok(Codes::Omega),	×
385	"VByteBe" => Ok(Codes::VByteBe),	×
386
387	_ => {
388	let mut parts = s.split('(');	×
389	let name = parts	×
390	.next()
391	.ok_or_else(\|\| CodeError::UnknownCode(array_format_error(s)))?;	×
392	let k = parts	×
393	.next()
394	.ok_or_else(\|\| CodeError::UnknownCode(array_format_error(s)))?	×
395	.split(')')
396	.next()
397	.ok_or_else(\|\| CodeError::UnknownCode(array_format_error(s)))?;	×
398	match name {	×
NEW 399	"Zeta" => Ok(Codes::Zeta(k.parse()?)),	×
NEW 400	"Pi" => Ok(Codes::Pi(k.parse()?)),	×
NEW 401	"Golomb" => Ok(Codes::Golomb(k.parse()?)),	×
NEW 402	"ExpGolomb" => Ok(Codes::ExpGolomb(k.parse()?)),	×
NEW 403	"Rice" => Ok(Codes::Rice(k.parse()?)),	×
UNCOV 404	_ => Err(CodeError::UnknownCode(array_format_error(name))),	×
405	}
406	}
407	}
408	}
409	}
410
411	/// Structure representing minimal binary coding with a fixed length.
412	///
413	/// [Minimal binary coding](crate::codes::minimal_binary) does not
414	/// fit the [`Codes`] enum because it is not defined for all integers.
415	///
416	/// Instances of this structure can be used in context in which a
417	/// [`DynamicCodeRead`], [`DynamicCodeWrite`], [`StaticCodeRead`],
418	/// [`StaticCodeWrite`] or [`CodeLen`] implementing minimal binary coding
419	/// is necessary.
420	#[derive(Clone, Copy, Debug, PartialEq, Eq)]
421	pub struct MinimalBinary(pub u64);
422
423	impl DynamicCodeRead for MinimalBinary {
424	fn read<E: Endianness, R: CodesRead<E> + ?Sized>(	48✔
425	&self,
426	reader: &mut R,
427	) -> Result<u64, R::Error> {
428	reader.read_minimal_binary(self.0)	144✔
429	}
430	}
431
432	impl DynamicCodeWrite for MinimalBinary {
433	fn write<E: Endianness, W: CodesWrite<E> + ?Sized>(	48✔
434	&self,
435	writer: &mut W,
436	n: u64,
437	) -> Result<usize, W::Error> {
438	writer.write_minimal_binary(n, self.0)	192✔
439	}
440	}
441
442	impl<E: Endianness, CR: CodesRead<E> + ?Sized> StaticCodeRead<E, CR> for MinimalBinary {
443	fn read(&self, reader: &mut CR) -> Result<u64, CR::Error> {	24✔
444	<Self as DynamicCodeRead>::read(self, reader)	72✔
445	}
446	}
447
448	impl<E: Endianness, CW: CodesWrite<E> + ?Sized> StaticCodeWrite<E, CW> for MinimalBinary {
449	fn write(&self, writer: &mut CW, n: u64) -> Result<usize, CW::Error> {	24✔
450	<Self as DynamicCodeWrite>::write(self, writer, n)	96✔
451	}
452	}
453
454	impl CodeLen for MinimalBinary {
455	fn len(&self, n: u64) -> usize {	48✔
456	len_minimal_binary(n, self.0)	144✔
457	}
458	}

vigna / dsi-bitstream-rs / 19989385183

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous