Struct BigEndianReader 

pub struct BigEndianReader<'a>(/* private fields */);

Reads bits in the big-endian format

use bitter::{BitReader, BigEndianReader};
let mut bebits = BigEndianReader::new(&[0b1000_0000]);
assert_eq!(bebits.read_bit(), Some(true));

Implementations

impl<'a> BigEndianReader<'a>

pub fn new(data: &'a [u8]) -> Self

Create a big endian reader from the given byte slice.

Trait Implementations

impl BitReader for BigEndianReader<'_>

fn read_bit(&mut self) -> Option<bool>

Consume a bit and return if the bit was enabled

fn read_u8(&mut self) -> Option<u8>

Consume 8 bits and return the deserialized byte

fn read_i8(&mut self) -> Option<i8>

Consume 8 bits and return the deserialized byte

fn read_u16(&mut self) -> Option<u16>

Consume 16 bits and return the deserialized short

fn read_i16(&mut self) -> Option<i16>

Consume 16 bits and return the deserialized short

fn read_u32(&mut self) -> Option<u32>

Consume 32 bits and return the deserialized int

fn read_i32(&mut self) -> Option<i32>

Consume 32 bits and return the deserialized int

fn read_f32(&mut self) -> Option<f32>

Consume 32 bits and return the deserialized floating point

fn read_u64(&mut self) -> Option<u64>

Consume 64 bits and return the deserialized int

fn read_i64(&mut self) -> Option<i64>

Consume 64 bits and return the deserialized int

fn read_f64(&mut self) -> Option<f64>

Consume 64 bits and return the deserialized floating point

fn read_bits(&mut self, bits: u32) -> Option<u64>

Reads an arbitrary number of bits in the range of [0, 64] and returns the unsigned result

fn read_signed_bits(&mut self, bits: u32) -> Option<i64>

Reads an arbitrary number of bits in the range of [0, 64] and returns the signed result.

fn bytes_remaining(&self) -> usize

Returns how many complete bytes are left in the bitstream.

fn unbuffered_bytes_remaining(&self) -> usize

Returns how many bytes are still left in the passed in buffer.

fn bits_remaining(&self) -> Option<usize>

Returns the exact number of bits remaining in the bitstream if the number of bits can fit within a usize. For large byte slices, calculating the number of bits can cause an overflow, hence an Option is returned. See has_bits_remaining for a more robust, performant, and ergonomic alternative.

fn has_bits_remaining(&self, bits: usize) -> bool

Returns true if at least bits number of bits are left in the stream. A more robust, performant, and ergonomic way than bits_remaining.

fn read_bytes(&mut self, buf: &mut [u8]) -> bool

Read the number of bytes needed to fill the provided buffer. Returns whether the read was successful and the buffer has been filled. If there aren’t enough bytes remaining, then the bit stream and buffer remains unchanged

fn is_empty(&self) -> bool

Returns if the bitstream has no bits left

fn peek(&self, count: u32) -> u64

Peeks at the given number of bits in the lookahead buffer

fn consume(&mut self, count: u32)

Consumes the number of bits from the lookahead buffer

fn lookahead_bits(&self) -> u32

Returns the number of bits in the lookahead buffer

fn refill_lookahead(&mut self)

Refills the lookahead buffer.

unsafe fn refill_lookahead_unchecked(&mut self)

Refills the lookahead buffer without bounds checking

fn byte_aligned(&self) -> bool

Returns true if the reader is not partway through a byte

fn remainder(&self) -> Remainder<'_>

Returns the remainder of unread data.

impl<'a> Clone for BigEndianReader<'a>

fn clone(&self) -> BigEndianReader<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for BigEndianReader<'a>

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

Formats the value using the given formatter.

impl<'a> Copy for BigEndianReader<'a>