Struct const_base::errors::ExcessBits

pub struct ExcessBits { /* private fields */ }

When the last byte in the slice passed to decode has excess set bits that aren’t copied to the return value.

Example

use const_base::{Config, DecodeError, decode};

assert_eq!(decode::<2>(b"ABA", Config::B64).unwrap(), [0u8, 16]);

// base 64 inputs of length 3 are 18 bits, which is 2 bytes and 2 excess bits.
// `ABC` is base64 for `[0b00000000, 0b00010000]` with excess `0b10` bits.
//
// Because the two unused bits at the end (which are `10`) include a set bit,
// it causes the `ExcessBits` error.
match decode::<2>(b"ABC", Config::B64) {
    Err(DecodeError::ExcessBits(err)) => {
        assert_eq!(err.last_byte(), b'C');
    }
    _ => unreachable!()
}

Implementations

impl ExcessBits

pub const fn last_byte(&self) -> u8

pub const fn unwrap<T: Copy>(res: Result<T, Self>) -> T

Unwraps a Result with this type as the error.

pub const fn panic(&self) -> !

Panics with this error as the message.

Trait Implementations

impl Debug for ExcessBits

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

Formats the value using the given formatter.

impl PartialEq<ExcessBits> for ExcessBits

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for ExcessBits