Struct bigbit::headbyte::HBNum

pub struct HBNum { /* fields omitted */ }

The Head Byte format, capable of storing integers and fractions up to ±1.34078079e+281.

See the [module-level documentation][modhb] for more. [modhb]: index.html "bigbit::headbyte — the Head Byte format, capable of storing integers and fractions up to ±1.34078079e+281"

Methods

impl HBNum

pub fn from_headbyte_and_followup(
    hb: HeadByte,
    followup: Vec<u8>
) -> Result<Self, ()>

#[must_use]pub fn headbyte(&self) -> HeadByte

Returns the head byte.

The results of inspecting the head byte are reliable and always match the properties of the actual value of the entire number. For example, if has_exponent on the head byte always returns true, there always is an exponent byte to retreieve.

#[must_use]pub fn exponent(&self) -> Option<Exponent>

Returns the exponent, or None if it's not used (mainly the case for integers).

pub fn coefficient_le_iter(
    &self
) -> impl Iterator<Item = u8> + DoubleEndedIterator + '_

Returns an iterator over the coefficients in little endian byte order.

pub fn coefficient_be_iter(
    &self
) -> impl Iterator<Item = u8> + DoubleEndedIterator + '_

Returns an iterator over the coefficients in big endian byte order.

Trait Implementations

impl Clone for HBNum

fn clone(&self) -> HBNum

Returns a copy of the value.

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

Performs copy-assignment from source.