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]>;
    pub fn one() -> Self;
    pub fn is_zero(self) -> bool;
    pub fn from_u8(u: u8) -> Self;
    pub fn to_u8(self) -> u8;
    pub fn count_ones(self) -> u32;
    pub fn leading_zeros(self) -> u32;
    pub fn trailing_zeros(self) -> u32;
    pub fn bits_size() -> u32;
    pub fn buffer() -> Self::Bytes;
    pub fn to_be_bytes(self) -> Self::Bytes;
    pub fn to_le_bytes(self) -> Self::Bytes;
    pub fn from_be_bytes(bytes: Self::Bytes) -> Self;
    pub fn from_le_bytes(bytes: Self::Bytes) -> Self;
    pub fn unsigned_value(self) -> UnsignedValue;
}

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.

Associated Types

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

The raw byte representation of this numeric type

Loading content...

Required methods

pub fn one() -> Self

The value of 1 in this type

pub fn is_zero(self) -> bool

Returns true if this value is 0, in its type

pub fn from_u8(u: u8) -> Self

Returns a u8 value in this type

pub fn to_u8(self) -> u8

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

pub fn count_ones(self) -> u32

Counts the number of 1 bits

pub fn leading_zeros(self) -> u32

Counts the number of leading zeros

pub fn trailing_zeros(self) -> u32

Counts the number of trailing zeros

pub fn bits_size() -> u32

Size of type in bits

pub fn buffer() -> Self::Bytes

An empty buffer of this type's size

pub fn to_be_bytes(self) -> Self::Bytes

Our value in big-endian bytes

pub fn to_le_bytes(self) -> Self::Bytes

Our value in little-endian bytes

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

Convert big-endian bytes to our value

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

Convert little-endian bytes to out value

pub fn unsigned_value(self) -> UnsignedValue

Convert to a generic unsigned write value for stream recording purposes

Loading content...

Implementations on Foreign Types

impl Numeric for u8

type Bytes = [u8; 1]

pub fn one() -> Self

pub fn is_zero(self) -> bool

pub fn from_u8(u: u8) -> Self

pub fn to_u8(self) -> u8

pub fn count_ones(self) -> u32

pub fn leading_zeros(self) -> u32

pub fn trailing_zeros(self) -> u32

pub fn bits_size() -> u32

pub fn buffer() -> Self::Bytes

pub fn to_be_bytes(self) -> Self::Bytes

pub fn to_le_bytes(self) -> Self::Bytes

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

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

pub fn unsigned_value(self) -> UnsignedValue

impl Numeric for i8

type Bytes = [u8; 1]

pub fn one() -> Self

pub fn is_zero(self) -> bool

pub fn from_u8(u: u8) -> Self

pub fn to_u8(self) -> u8

pub fn count_ones(self) -> u32

pub fn leading_zeros(self) -> u32

pub fn trailing_zeros(self) -> u32

pub fn bits_size() -> u32

pub fn buffer() -> Self::Bytes

pub fn to_be_bytes(self) -> Self::Bytes

pub fn to_le_bytes(self) -> Self::Bytes

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

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

pub fn unsigned_value(self) -> UnsignedValue

impl Numeric for u16

type Bytes = [u8; 2]

pub fn one() -> Self

pub fn is_zero(self) -> bool

pub fn from_u8(u: u8) -> Self

pub fn to_u8(self) -> u8

pub fn count_ones(self) -> u32

pub fn leading_zeros(self) -> u32

pub fn trailing_zeros(self) -> u32

pub fn bits_size() -> u32

pub fn buffer() -> Self::Bytes

pub fn to_be_bytes(self) -> Self::Bytes

pub fn to_le_bytes(self) -> Self::Bytes

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

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

pub fn unsigned_value(self) -> UnsignedValue

impl Numeric for i16

type Bytes = [u8; 2]

pub fn one() -> Self

pub fn is_zero(self) -> bool

pub fn from_u8(u: u8) -> Self

pub fn to_u8(self) -> u8

pub fn count_ones(self) -> u32

pub fn leading_zeros(self) -> u32

pub fn trailing_zeros(self) -> u32

pub fn bits_size() -> u32

pub fn buffer() -> Self::Bytes

pub fn to_be_bytes(self) -> Self::Bytes

pub fn to_le_bytes(self) -> Self::Bytes

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

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

pub fn unsigned_value(self) -> UnsignedValue

impl Numeric for u32

type Bytes = [u8; 4]

pub fn one() -> Self

pub fn is_zero(self) -> bool

pub fn from_u8(u: u8) -> Self

pub fn to_u8(self) -> u8

pub fn count_ones(self) -> u32

pub fn leading_zeros(self) -> u32

pub fn trailing_zeros(self) -> u32

pub fn bits_size() -> u32

pub fn buffer() -> Self::Bytes

pub fn to_be_bytes(self) -> Self::Bytes

pub fn to_le_bytes(self) -> Self::Bytes

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

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

pub fn unsigned_value(self) -> UnsignedValue

impl Numeric for i32

type Bytes = [u8; 4]

pub fn one() -> Self

pub fn is_zero(self) -> bool

pub fn from_u8(u: u8) -> Self

pub fn to_u8(self) -> u8

pub fn count_ones(self) -> u32

pub fn leading_zeros(self) -> u32

pub fn trailing_zeros(self) -> u32

pub fn bits_size() -> u32

pub fn buffer() -> Self::Bytes

pub fn to_be_bytes(self) -> Self::Bytes

pub fn to_le_bytes(self) -> Self::Bytes

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

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

pub fn unsigned_value(self) -> UnsignedValue

impl Numeric for u64

type Bytes = [u8; 8]

pub fn one() -> Self

pub fn is_zero(self) -> bool

pub fn from_u8(u: u8) -> Self

pub fn to_u8(self) -> u8

pub fn count_ones(self) -> u32

pub fn leading_zeros(self) -> u32

pub fn trailing_zeros(self) -> u32

pub fn bits_size() -> u32

pub fn buffer() -> Self::Bytes

pub fn to_be_bytes(self) -> Self::Bytes

pub fn to_le_bytes(self) -> Self::Bytes

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

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

pub fn unsigned_value(self) -> UnsignedValue

impl Numeric for i64

type Bytes = [u8; 8]

pub fn one() -> Self

pub fn is_zero(self) -> bool

pub fn from_u8(u: u8) -> Self

pub fn to_u8(self) -> u8

pub fn count_ones(self) -> u32

pub fn leading_zeros(self) -> u32

pub fn trailing_zeros(self) -> u32

pub fn bits_size() -> u32

pub fn buffer() -> Self::Bytes

pub fn to_be_bytes(self) -> Self::Bytes

pub fn to_le_bytes(self) -> Self::Bytes

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

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

pub fn unsigned_value(self) -> UnsignedValue

impl Numeric for u128

type Bytes = [u8; 16]

pub fn one() -> Self

pub fn is_zero(self) -> bool

pub fn from_u8(u: u8) -> Self

pub fn to_u8(self) -> u8

pub fn count_ones(self) -> u32

pub fn leading_zeros(self) -> u32

pub fn trailing_zeros(self) -> u32

pub fn bits_size() -> u32

pub fn buffer() -> Self::Bytes

pub fn to_be_bytes(self) -> Self::Bytes

pub fn to_le_bytes(self) -> Self::Bytes

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

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

pub fn unsigned_value(self) -> UnsignedValue

impl Numeric for i128

type Bytes = [u8; 16]

pub fn one() -> Self

pub fn is_zero(self) -> bool

pub fn from_u8(u: u8) -> Self

pub fn to_u8(self) -> u8

pub fn count_ones(self) -> u32

pub fn leading_zeros(self) -> u32

pub fn trailing_zeros(self) -> u32

pub fn bits_size() -> u32

pub fn buffer() -> Self::Bytes

pub fn to_be_bytes(self) -> Self::Bytes

pub fn to_le_bytes(self) -> Self::Bytes

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

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

pub fn unsigned_value(self) -> UnsignedValue

Loading content...

Implementors

Loading content...