Enum Codes 

#[non_exhaustive]
pub enum Codes {
    Unary,
    Gamma,
    Delta,
    Omega,
    VByteLe,
    VByteBe,
    Zeta(usize),
    Pi(usize),
    Golomb(u64),
    ExpGolomb(usize),
    Rice(usize),
}

An enum whose variants represent all the available codes.

This enum is kept in sync with implementations in the codes module.

Both Display and FromStr are implemented for this enum in a compatible way, making it possible to store a code as a string in a configuration file and then parse it back.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Unary

Gamma

Delta

Omega

VByteLe

VByteBe

Zeta(usize)

Pi(usize)

Golomb(u64)

ExpGolomb(usize)

Rice(usize)

Implementations

impl Codes

pub const fn canonicalize(self) -> Self

Returns the canonical form of this code.

Some codes are equivalent, in the sense that they are defined differently, but they give rise to the same codewords. Among equivalent codes, there is usually one that is faster to encode and decode, which we call the canonical representative of the equivalence class.

The mapping is:

• Rice(0), Golomb(1) → Unary

• Zeta(1), ExpGolomb(0), Pi(0) → Gamma

• Golomb(2ⁿ) → Rice(n)

pub fn read<E: Endianness, CR: CodesRead<E> + ?Sized>( &self, reader: &mut CR, ) -> Result<u64, CR::Error>

Delegates to the DynamicCodeRead implementation.

This inherent method is provided to reduce ambiguity in method resolution.

pub fn write<E: Endianness, CW: CodesWrite<E> + ?Sized>( &self, writer: &mut CW, n: u64, ) -> Result<usize, CW::Error>

Delegates to the DynamicCodeWrite implementation.

This inherent method is provided to reduce ambiguity in method resolution.

pub const fn to_code_const(&self) -> Result<usize, DispatchError>

Converts a code to the constants in the code_consts module used for ConstCode. This is mostly used to verify that the code is supported by ConstCode.

The code is canonicalized before the conversion, so equivalent codes map to the same constant.

Errors

Returns DispatchError::UnsupportedCode if the (canonicalized) code has no corresponding constant in code_consts.

pub const fn from_code_const(const_code: usize) -> Result<Self, DispatchError>

Converts a value from code_consts to a code.

Errors

Returns DispatchError::UnsupportedCodeConst if the value does not correspond to any known code constant.

Trait Implementations

impl Clone for Codes

fn clone(&self) -> Codes

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl CodeLen for Codes

fn len(&self, n: u64) -> usize

Returns the length of the codeword for n.

impl Debug for Codes

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Codes

Available on crate feature serde only.

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Codes

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl DynamicCodeRead for Codes

fn read<E: Endianness, CR: CodesRead<E> + ?Sized>( &self, reader: &mut CR, ) -> Result<u64, CR::Error>

impl DynamicCodeWrite for Codes

fn write<E: Endianness, CW: CodesWrite<E> + ?Sized>( &self, writer: &mut CW, n: u64, ) -> Result<usize, CW::Error>

impl FlatType for Codes

where usize: MemSize + FlatType, u64: MemSize + FlatType,

type Flat = True

impl FromStr for Codes

type Err = CodeError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for Codes

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl MemDbgImpl for Codes

where usize: MemDbgImpl + FlatType, u64: MemDbgImpl + FlatType,

fn _mem_dbg_rec_on( &self, _memdbg_writer: &mut impl Write, _memdbg_total_size: usize, _memdbg_max_depth: usize, _memdbg_prefix: &mut String, _memdbg_is_last: bool, _memdbg_flags: DbgFlags, _memdbg_refs: &mut HashSet<usize>, ) -> Result

fn _mem_dbg_depth_on( &self, writer: &mut impl Write, total_size: usize, max_depth: usize, prefix: &mut String, field_name: Option<&str>, is_last: bool, padded_size: usize, flags: DbgFlags, dbg_refs: &mut HashSet<usize>, ) -> Result<(), Error>

fn _mem_dbg_depth_on_impl( &self, writer: &mut impl Write, total_size: usize, max_depth: usize, prefix: &mut String, field_name: Option<&str>, is_last: bool, padded_size: usize, flags: DbgFlags, dbg_refs: &mut HashSet<usize>, ref_display: RefDisplay, ) -> Result<(), Error>

Internal implementation for depth display.

impl MemSize for Codes

where usize: MemSize + FlatType, u64: MemSize + FlatType,

fn mem_size_rec( &self, _memsize_flags: SizeFlags, _memsize_refs: &mut HashMap<usize, usize>, ) -> usize

Recursive implementation that tracks visited references for deduplication.

fn mem_size(&self, flags: SizeFlags) -> usize

Returns the (recursively computed) overall memory size of the structure in bytes.

impl PartialEq for Codes

fn eq(&self, other: &Codes) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Codes

Available on crate feature serde only.

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl<E: Endianness, CR: CodesRead<E> + ?Sized> StaticCodeRead<E, CR> for Codes

fn read(&self, reader: &mut CR) -> Result<u64, CR::Error>

impl<E: Endianness, CW: CodesWrite<E> + ?Sized> StaticCodeWrite<E, CW> for Codes

fn write(&self, writer: &mut CW, n: u64) -> Result<usize, CW::Error>

impl Copy for Codes

impl Eq for Codes

impl StructuralPartialEq for Codes