Trait bitstream_io::Numeric

pub trait Numeric: Sized + Copy + Default + Debug + PartialOrd + Shl<u32, Output = Self> + ShlAssign<u32> + Shr<u32, Output = Self> + ShrAssign<u32> + Rem<Self, Output = Self> + RemAssign<Self> + BitOrAssign<Self> + BitXor<Self, Output = Self> + Not<Output = Self> + Sub<Self, Output = Self> {
    type Bytes: AsRef<[u8]> + AsMut<[u8]>;

    const BITS_SIZE: u32;
    const ONE: Self;

    // Required methods
    fn is_zero(self) -> bool;
    fn from_u8(u: u8) -> Self;
    fn to_u8(self) -> u8;
    fn count_ones(self) -> u32;
    fn leading_zeros(self) -> u32;
    fn trailing_zeros(self) -> u32;
    fn buffer() -> Self::Bytes;
    fn to_be_bytes(self) -> Self::Bytes;
    fn to_le_bytes(self) -> Self::Bytes;
    fn from_be_bytes(bytes: Self::Bytes) -> Self;
    fn from_le_bytes(bytes: Self::Bytes) -> Self;
    fn unsigned_value(self) -> UnsignedValue;
}

Expand description

This trait extends many common integer types (both unsigned and signed) with a few trivial methods so that they can be used with the bitstream handling traits.

Required Associated Types§

type Bytes: AsRef<[u8]> + AsMut<[u8]>

The raw byte representation of this numeric type

Required Associated Constants§

const BITS_SIZE: u32

Size of type in bits

const ONE: Self

The value of 1 in this type

Required Methods§

fn is_zero(self) -> bool

Returns true if this value is 0, in its type

fn from_u8(u: u8) -> Self

Returns a u8 value in this type

fn to_u8(self) -> u8

Assuming 0 <= value < 256, returns this value as a u8 type

fn count_ones(self) -> u32

Counts the number of 1 bits

fn leading_zeros(self) -> u32

Counts the number of leading zeros

fn trailing_zeros(self) -> u32

Counts the number of trailing zeros

fn buffer() -> Self::Bytes

An empty buffer of this type’s size

fn to_be_bytes(self) -> Self::Bytes

Our value in big-endian bytes

fn to_le_bytes(self) -> Self::Bytes

Our value in little-endian bytes

fn from_be_bytes(bytes: Self::Bytes) -> Self

Convert big-endian bytes to our value

fn from_le_bytes(bytes: Self::Bytes) -> Self

Convert little-endian bytes to out value

fn unsigned_value(self) -> UnsignedValue

Convert to a generic unsigned write value for stream recording purposes

Implementations on Foreign Types§

impl Numeric for i64

type Bytes = [u8; 8]

const BITS_SIZE: u32 = 64u32

const ONE: Self = 1i64

fn is_zero(self) -> bool

fn from_u8(u: u8) -> Self

fn to_u8(self) -> u8

fn count_ones(self) -> u32

fn leading_zeros(self) -> u32

fn trailing_zeros(self) -> u32

fn buffer() -> Self::Bytes

fn to_be_bytes(self) -> Self::Bytes

fn to_le_bytes(self) -> Self::Bytes

fn from_be_bytes(bytes: Self::Bytes) -> Self

fn from_le_bytes(bytes: Self::Bytes) -> Self

fn unsigned_value(self) -> UnsignedValue

impl Numeric for u16

type Bytes = [u8; 2]

const BITS_SIZE: u32 = 16u32

const ONE: Self = 1u16

fn is_zero(self) -> bool

fn from_u8(u: u8) -> Self

fn to_u8(self) -> u8

fn count_ones(self) -> u32

fn leading_zeros(self) -> u32

fn trailing_zeros(self) -> u32

fn buffer() -> Self::Bytes

fn to_be_bytes(self) -> Self::Bytes

fn to_le_bytes(self) -> Self::Bytes

fn from_be_bytes(bytes: Self::Bytes) -> Self

fn from_le_bytes(bytes: Self::Bytes) -> Self

fn unsigned_value(self) -> UnsignedValue

impl Numeric for i32

type Bytes = [u8; 4]

const BITS_SIZE: u32 = 32u32

const ONE: Self = 1i32

fn is_zero(self) -> bool

fn from_u8(u: u8) -> Self

fn to_u8(self) -> u8

fn count_ones(self) -> u32

fn leading_zeros(self) -> u32

fn trailing_zeros(self) -> u32

fn buffer() -> Self::Bytes

fn to_be_bytes(self) -> Self::Bytes

fn to_le_bytes(self) -> Self::Bytes

fn from_be_bytes(bytes: Self::Bytes) -> Self

fn from_le_bytes(bytes: Self::Bytes) -> Self

fn unsigned_value(self) -> UnsignedValue

impl Numeric for i16

type Bytes = [u8; 2]

const BITS_SIZE: u32 = 16u32

const ONE: Self = 1i16

fn is_zero(self) -> bool

fn from_u8(u: u8) -> Self

fn to_u8(self) -> u8

fn count_ones(self) -> u32

fn leading_zeros(self) -> u32

fn trailing_zeros(self) -> u32

fn buffer() -> Self::Bytes

fn to_be_bytes(self) -> Self::Bytes

fn to_le_bytes(self) -> Self::Bytes

fn from_be_bytes(bytes: Self::Bytes) -> Self

fn from_le_bytes(bytes: Self::Bytes) -> Self

fn unsigned_value(self) -> UnsignedValue

impl Numeric for u32

type Bytes = [u8; 4]

const BITS_SIZE: u32 = 32u32

const ONE: Self = 1u32

fn is_zero(self) -> bool

fn from_u8(u: u8) -> Self

fn to_u8(self) -> u8

fn count_ones(self) -> u32

fn leading_zeros(self) -> u32

fn trailing_zeros(self) -> u32

fn buffer() -> Self::Bytes

fn to_be_bytes(self) -> Self::Bytes

fn to_le_bytes(self) -> Self::Bytes

fn from_be_bytes(bytes: Self::Bytes) -> Self

fn from_le_bytes(bytes: Self::Bytes) -> Self

fn unsigned_value(self) -> UnsignedValue

impl Numeric for u128

type Bytes = [u8; 16]

const BITS_SIZE: u32 = 128u32

const ONE: Self = 1u128

fn is_zero(self) -> bool

fn from_u8(u: u8) -> Self

fn to_u8(self) -> u8

fn count_ones(self) -> u32

fn leading_zeros(self) -> u32

fn trailing_zeros(self) -> u32

fn buffer() -> Self::Bytes

fn to_be_bytes(self) -> Self::Bytes

fn to_le_bytes(self) -> Self::Bytes

fn from_be_bytes(bytes: Self::Bytes) -> Self

fn from_le_bytes(bytes: Self::Bytes) -> Self

fn unsigned_value(self) -> UnsignedValue

impl Numeric for i8

type Bytes = [u8; 1]

const BITS_SIZE: u32 = 8u32

const ONE: Self = 1i8

fn is_zero(self) -> bool

fn from_u8(u: u8) -> Self

fn to_u8(self) -> u8

fn count_ones(self) -> u32

fn leading_zeros(self) -> u32

fn trailing_zeros(self) -> u32

fn buffer() -> Self::Bytes

fn to_be_bytes(self) -> Self::Bytes

fn to_le_bytes(self) -> Self::Bytes

fn from_be_bytes(bytes: Self::Bytes) -> Self

fn from_le_bytes(bytes: Self::Bytes) -> Self

fn unsigned_value(self) -> UnsignedValue

impl Numeric for i128

type Bytes = [u8; 16]

const BITS_SIZE: u32 = 128u32

const ONE: Self = 1i128

fn is_zero(self) -> bool

fn from_u8(u: u8) -> Self

fn to_u8(self) -> u8

fn count_ones(self) -> u32

fn leading_zeros(self) -> u32

fn trailing_zeros(self) -> u32

fn buffer() -> Self::Bytes

fn to_be_bytes(self) -> Self::Bytes

fn to_le_bytes(self) -> Self::Bytes

fn from_be_bytes(bytes: Self::Bytes) -> Self

fn from_le_bytes(bytes: Self::Bytes) -> Self

fn unsigned_value(self) -> UnsignedValue

impl Numeric for u8

type Bytes = [u8; 1]

const BITS_SIZE: u32 = 8u32

const ONE: Self = 1u8

fn is_zero(self) -> bool

fn from_u8(u: u8) -> Self

fn to_u8(self) -> u8

fn count_ones(self) -> u32

fn leading_zeros(self) -> u32

fn trailing_zeros(self) -> u32

fn buffer() -> Self::Bytes

fn to_be_bytes(self) -> Self::Bytes

fn to_le_bytes(self) -> Self::Bytes

fn from_be_bytes(bytes: Self::Bytes) -> Self

fn from_le_bytes(bytes: Self::Bytes) -> Self

fn unsigned_value(self) -> UnsignedValue

impl Numeric for u64

type Bytes = [u8; 8]

const BITS_SIZE: u32 = 64u32

const ONE: Self = 1u64

fn is_zero(self) -> bool

fn from_u8(u: u8) -> Self

fn to_u8(self) -> u8

fn count_ones(self) -> u32

fn leading_zeros(self) -> u32

fn trailing_zeros(self) -> u32

fn buffer() -> Self::Bytes

fn to_be_bytes(self) -> Self::Bytes

fn to_le_bytes(self) -> Self::Bytes

fn from_be_bytes(bytes: Self::Bytes) -> Self

fn from_le_bytes(bytes: Self::Bytes) -> Self

fn unsigned_value(self) -> UnsignedValue

Implementors§