Struct BitBuf 

pub struct BitBuf<S> { /* private fields */ }

The main structure

Keeps track of the data storage and a cursor for automatic operations

Implementations

impl<S> BitBuf<S>

pub const fn from(data: S) -> Self

Construct from provided data storage

pub fn bytes(&self) -> &[u8]

where S: Storage,

Get the underlying bytes from the storage

pub fn bytes_mut(&mut self) -> &mut [u8]

where S: StorageMut,

Get the underlying bytes from the storage

pub fn pos(&self) -> usize

Get the internal cursor for automatic operations

The cursor may not be within storage bounds

pub fn byte_pos(&self) -> usize

Get the byte-aligned position of the internal cursor for automatic operations

The cursor may not be within storage bounds

pub fn advance(&mut self, bits: usize) -> &mut Self

Advance the internal cursor for automatic operations

This does not enforce that the cursor stay within storage bounds

pub fn advance_bytes(&mut self, bytes: usize) -> &mut Self

Advance the internal cursor for automatic operations by a number of bytes

This does not enforce that the cursor stay within storage bounds

pub fn seek(&mut self, offset: usize) -> &mut Self

Set the internal cursor for automatic operations

This does not enforce that the cursor stay within storage bounds

pub fn seek_byte(&mut self, byte: usize) -> &mut Self

Set the internal cursor for automatic operations to a byte position

This sets the cursor to offset * 8 bits.

This does not enforce that the cursor stay within storage bounds

pub fn is_aligned(&self) -> bool

Checks if the internal cursor for automatic operations is aligned on the start of a byte

This does not care whether the cursor is outside storage bounds

impl<S: Storage> BitBuf<S>

pub unsafe fn read_u8_be_aligned_full_at_unchecked( &self, byte_offset: usize, ) -> u8

Read a BE-bit-order u8 from byte_offset without performing bound checks

Safety

• This is UB if byte_offset >= self.bytes().len()

Panics

• Panics in debug mode if byte_offset >= self.bytes().len()

pub unsafe fn read_u8_be_aligned_full_unchecked(&mut self) -> u8

Read the next BE-bit-order u8 without performing bound checks, advancing the internal cursor

Safety

• The internal cursor must be byte-aligned (self.is_aligned())
• This is UB if the internal cursor points past the end of storage (self.byte_pos() >= self.bytes().len())

Panics

• Panics in debug mode if the internal cursor is not byte-aligned (!self.is_aligned())
• Panics in debug mode if the internal cursor points past the end of storage (self.byte_pos() >= self.bytes().len())

pub unsafe fn read_u8_be_full_at_unchecked(&self, offset: usize) -> u8

Read a BE-bit-order u8 from offset without performing bound checks

Safety

• This is UB if (offset / 8) >= self.bytes().len()
• This is UB if (offset % 8 != 0) && (offset / 8) + 1 >= self.bytes().len()

Panics

• Panics in debug mode if (offset / 8) >= self.bytes().len()
• Panics in debug mode if (offset % 8 != 0) && (offset / 8) + 1 >= self.bytes().len()

pub unsafe fn read_u8_be_full_unchecked(&mut self) -> u8

Read the next BE-bit-order u8 without performing bound checks, advancing the internal cursor

Safety

• This is UB if (self.pos() / 8) >= self.bytes().len()
• This is UB if (self.pos() % 8 != 0) && (self.pos() / 8) + 1 >= self.bytes().len()

Panics

• Panics in debug mode if (self.pos() / 8) >= self.bytes().len()
• Panics in debug mode if (self.pos() % 8 != 0) && (self.pos() / 8) + 1 >= self.bytes().len()

pub fn try_read_u8_be_full_at(&self, offset: usize) -> Result<u8>

Read a BE-bit-order u8 from offset while performing bound checks

Errors

• Returns Error::OutOfBounds
  • if (offset / 8) >= self.bytes().len()
  • if (offset % 8 != 0) && (offset / 8) + 1 >= self.bytes().len()

pub fn try_read_u8_be_full(&mut self) -> Result<u8>

Read the next BE-bit-order u8 while performing bound checks, advancing the internal cursor

Errors

• Returns Error::OutOfBounds
  • if (self.pos() / 8) >= self.bytes().len()
  • if (self.pos() % 8 != 0) && (self.pos() / 8) + 1 >= self.bytes().len()

pub fn read_u8_be_full_at(&self, offset: usize) -> u8

Read a BE-bit-order u8 from offset, panicking on out of bounds

Panics

• Panics if (offset / 8) >= self.bytes().len()
• Panics if (offset % 8 != 0) && (offset / 8) + 1 >= self.bytes().len()

pub fn read_u8_be_full(&mut self) -> u8

Read the next BE-bit-order u8, panicking on out of bounds, advancing the internal cursor

Panics

• Panics if (self.pos() / 8) >= self.bytes().len()
• Panics if (self.pos() % 8 != 0) && (self.pos() / 8) + 1 >= self.bytes().len()

pub unsafe fn read_u16_be_aligned_full_at_unchecked( &self, byte_offset: usize, ) -> u16

Read a [BE-bit, BE-byte] order u16 from byte_offset without performing bound checks

Safety

• This is UB if byte_offset + 1 >= self.bytes().len()

Panics

• Panics in debug mode if byte_offset + 1 >= self.bytes().len()

pub unsafe fn read_u16_be_aligned_full_unchecked(&mut self) -> u16

Read the next [BE-bit, BE-byte] order u16 without performing bound checks, advancing the internal cursor

Safety

• The internal cursor must be byte-aligned (self.is_aligned())
• This is UB if the internal cursor points past the end of storage (self.byte_pos() + 1 >= self.bytes().len())

Panics

• Panics in debug mode if the internal cursor is not byte-aligned (!self.is_aligned())
• Panics in debug mode if the internal cursor points past the end of storage (self.byte_pos() + 1 >= self.bytes().len())

pub unsafe fn read_u16_be_full_at_unchecked(&self, offset: usize) -> u16

Read a [BE-bit, BE-byte] order u16 from offset without performing bound checks

Safety

• This is UB if (offset / 8) + 1 >= self.bytes().len()
• This is UB if (offset % 8 != 0) && (offset / 8) + 2 >= self.bytes().len()

Panics

• Panics in debug mode if (offset / 8) + 1 >= self.bytes().len()
• Panics in debug mode if (offset % 8 != 0) && (offset / 8) + 2 >= self.bytes().len()

pub unsafe fn read_u16_be_full_unchecked(&mut self) -> u16

Read the next [BE-bit, BE-byte] order u16 without performing bound checks, advancing the internal cursor

Safety

• This is UB if (self.pos() / 8) + 1 >= self.bytes().len()
• This is UB if (self.pos() % 8 != 0) && (self.pos() / 8) + 2 >= self.bytes().len()

Panics

• Panics in debug mode if (self.pos() / 8) + 1 >= self.bytes().len()
• Panics in debug mode if (self.pos() % 8 != 0) && (self.pos() / 8) + 2 >= self.bytes().len()

pub fn try_read_u16_be_full_at(&self, offset: usize) -> Result<u16>

Read a [BE-bit, BE-byte] order u16 from offset while performing bound checks

Errors

• Returns Error::OutOfBounds
  • if (offset / 8) + 1 >= self.bytes().len()
  • if (offset % 8 != 0) && (offset / 8) + 2 >= self.bytes().len()

pub fn try_read_u16_be_full(&mut self) -> Result<u16>

Read the next [BE-bit, BE-byte] order u16 while performing bound checks, advancing the internal cursor

Errors

• Returns Error::OutOfBounds
  • if (self.pos() / 8) + 1 >= self.bytes().len()
  • if (self.pos() % 8 != 0) && (self.pos() / 8) + 2 >= self.bytes().len()

pub fn read_u16_be_full_at(&self, offset: usize) -> u16

Read a [BE-bit, BE-byte] order u16 from offset, panicking on out of bounds

Panics

• Panics if (offset / 8) + 1 >= self.bytes().len()
• Panics if (offset % 8 != 0) && (offset / 8) + 2 >= self.bytes().len()

pub fn read_u16_be_full(&mut self) -> u16

Read the next [BE-bit, BE-byte] order u16, panicking on out of bounds, advancing the internal cursor

Panics

• Panics if (self.pos() / 8) + 1 >= self.bytes().len()
• Panics if (self.pos() % 8 != 0) && (self.pos() / 8) + 2 >= self.bytes().len()

impl<S: Storage> BitBuf<S>

pub unsafe fn read_be_aligned_full_at_unchecked<T: Read>( &self, byte_offset: usize, ) -> T

Read a [BE-bit, BE-byte] order type T from byte_offset without performing bound checks

Safety

All semantics of the corresponding function for the type apply

Panics

All semantics of the corresponding function for the type apply

pub unsafe fn read_be_aligned_full_unchecked<T: Read>(&mut self) -> T

Read the next [BE-bit, BE-byte] order type T without performing bound checks, advancing the internal cursor

Safety

All semantics of the corresponding function for the type apply

Panics

All semantics of the corresponding function for the type apply

pub unsafe fn read_be_full_at_unchecked<T: Read>(&self, offset: usize) -> T

Read a [BE-bit, BE-byte] order type T from offset without performing bound checks

Safety

All semantics of the corresponding function for the type apply

Panics

All semantics of the corresponding function for the type apply

pub unsafe fn read_be_full_unchecked<T: Read>(&mut self) -> T

Read the next [BE-bit, BE-byte] order type T without performing bound checks, advancing the internal cursor

Safety

All semantics of the corresponding function for the type apply

Panics

All semantics of the corresponding function for the type apply

pub fn try_read_be_full_at<T: Read>(&self, offset: usize) -> Result<T>

Read a [BE-bit, BE-byte] order type T from offset while performing bound checks

Errors

All semantics of the corresponding function for the type apply

pub fn try_read_be_full<T: Read>(&mut self) -> Result<T>

Read the next [BE-bit, BE-byte] order type T while performing bound checks, advancing the internal cursor

Errors

All semantics of the corresponding function for the type apply

pub fn read_be_full_at<T: Read>(&self, offset: usize) -> T

Read a [BE-bit, BE-byte] order type T from offset, panicking on out of bounds

Panics

All semantics of the corresponding function for the type apply

pub fn read_be_full<T: Read>(&mut self) -> T

Read the next [BE-bit, BE-byte] order type T, panicking on out of bounds, advancing the internal cursor

Panics

All semantics of the corresponding function for the type apply

impl<S: StorageMut> BitBuf<S>

pub unsafe fn write_u8_be_aligned_full_at_unchecked( &mut self, byte_offset: usize, v: u8, ) -> &mut Self

Write a u8 in BE-bit-order at byte_offset without performing bound checks

Safety

• This is UB if byte_offset >= self.bytes().len()

Panics

• Panics in debug mode if byte_offset >= self.bytes().len()

pub unsafe fn write_u8_be_aligned_full_unchecked(&mut self, v: u8) -> &mut Self

Write a u8 in BE-bit-order without performing bound checks, advancing the internal cursor

Safety

• The internal cursor must be byte-aligned (self.is_aligned())
• This is UB if the internal cursor points past the end of storage (self.byte_pos() >= self.bytes().len())

Panics

• Panics in debug mode if the internal cursor is not byte-aligned (!self.is_aligned())
• Panics in debug mode if the internal cursor points past the end of storage (self.byte_pos() >= self.bytes().len())

pub unsafe fn write_u8_be_full_at_unchecked( &mut self, offset: usize, v: u8, ) -> &mut Self

Write a u8 in BE-bit-order at offset without performing bound checks

Safety

• This is UB if (offset / 8) >= self.bytes().len()
• This is UB if (offset % 8 != 0) && (offset / 8) + 1 >= self.bytes().len()

Panics

• Panics in debug mode if (offset / 8) >= self.bytes().len()
• Panics in debug mode if (offset % 8 != 0) && (offset / 8) + 1 >= self.bytes().len()

pub unsafe fn write_u8_be_full_unchecked(&mut self, v: u8) -> &mut Self

Write a u8 in BE-bit-order without performing bound checks, advancing the internal cursor

Safety

• This is UB if (self.pos() / 8) >= self.bytes().len()
• This is UB if (self.pos() % 8 != 0) && (self.pos() / 8) + 1 >= self.bytes().len()

Panics

• Panics in debug mode if (self.pos() / 8) >= self.bytes().len()
• Panics in debug mode if (self.pos() % 8 != 0) && (self.pos() / 8) + 1 >= self.bytes().len()

pub fn try_write_u8_be_full_at( &mut self, offset: usize, v: u8, ) -> Result<&mut Self>

Write a BE-bit-order u8 at offset while performing bound checks

Errors

• Returns Error::OutOfBounds
  • if (offset / 8) >= self.bytes().len()
  • if (offset % 8 != 0) && (offset / 8) + 1 >= self.bytes().len()

pub fn try_write_u8_be_full(&mut self, v: u8) -> Result<&mut Self>

Write a BE-bit-order u8 while performing bound checks, advancing the internal cursor

Errors

• Returns Error::OutOfBounds
  • if (self.pos() / 8) >= self.bytes().len()
  • if (self.pos() % 8 != 0) && (self.pos() / 8) + 1 >= self.bytes().len()

pub fn write_u8_be_full_at(&mut self, offset: usize, v: u8) -> &mut Self

Write a BE-bit-order u8 at offset, panicking on out of bounds

Panics

• Panics if (offset / 8) >= self.bytes().len()
• Panics if (offset % 8 != 0) && (offset / 8) + 1 >= self.bytes().len()

pub fn write_u8_be_full(&mut self, v: u8) -> &mut Self

Write a BE-bit-order u8, panicking on out of bounds, advancing the internal cursor

Panics

• Panics if (self.pos() / 8) >= self.bytes().len()
• Panics if (self.pos() % 8 != 0) && (self.pos() / 8) + 1 >= self.bytes().len()

pub unsafe fn write_u16_be_aligned_full_at_unchecked( &mut self, byte_offset: usize, v: u16, ) -> &mut Self

Write a u16 in [BE-bit, BE-byte] order at byte_offset without performing bound checks

Safety

• This is UB if byte_offset + 1 >= self.bytes().len()

Panics

• Panics in debug mode if byte_offset + 1 >= self.bytes().len()

pub unsafe fn write_u16_be_aligned_full_unchecked( &mut self, v: u16, ) -> &mut Self

Write a u16 in [BE-bit, BE-byte] order without performing bound checks, advancing the internal cursor

Safety

• The internal cursor must be byte-aligned (self.is_aligned())
• This is UB if the internal cursor points past the end of storage (self.byte_pos() + 1 >= self.bytes().len())

Panics

• Panics in debug mode if the internal cursor is not byte-aligned (!self.is_aligned())
• Panics in debug mode if the internal cursor points past the end of storage (self.byte_pos() + 1 >= self.bytes().len())

pub unsafe fn write_u16_be_full_at_unchecked( &mut self, offset: usize, v: u16, ) -> &mut Self

Write a u16 in [BE-bit, BE-byte] order at offset without performing bound checks

Safety

• This is UB if (offset / 8) + 1 >= self.bytes().len()
• This is UB if (offset % 8 != 0) && (offset / 8) + 2 >= self.bytes().len()

Panics

• Panics in debug mode if (offset / 8) + 1 >= self.bytes().len()
• Panics in debug mode if (offset % 8 != 0) && (offset / 8) + 2 >= self.bytes().len()

pub unsafe fn write_u16_be_full_unchecked(&mut self, v: u16) -> &mut Self

Write a u16 in [BE-bit, BE-byte] order without performing bound checks, advancing the internal cursor

Safety

• This is UB if (self.pos() / 8) + 1 >= self.bytes().len()
• This is UB if (self.pos() % 8 != 0) && (self.pos() / 8) + 2 >= self.bytes().len()

Panics

• Panics in debug mode if (self.pos() / 8) + 1 >= self.bytes().len()
• Panics in debug mode if (self.pos() % 8 != 0) && (self.pos() / 8) + 2 >= self.bytes().len()

pub fn try_write_u16_be_full_at( &mut self, offset: usize, v: u16, ) -> Result<&mut Self>

Write a [BE-bit, BE-byte] order u16 at offset while performing bound checks

Errors

• Returns Error::OutOfBounds
  • if (offset / 8) + 1 >= self.bytes().len()
  • if (offset % 8 != 0) && (offset / 8) + 2 >= self.bytes().len()

pub fn try_write_u16_be_full(&mut self, v: u16) -> Result<&mut Self>

Write a [BE-bit, BE-byte] order u16 while performing bound checks, advancing the internal cursor

Errors

• Returns Error::OutOfBounds
  • if (self.pos() / 8) + 1 >= self.bytes().len()
  • if (self.pos() % 8 != 0) && (self.pos() / 8) + 2 >= self.bytes().len()

pub fn write_u16_be_full_at(&mut self, offset: usize, v: u16) -> &mut Self

Write a [BE-bit, BE-byte] order u16 at offset, panicking on out of bounds

Panics

• Panics if (offset / 8) + 1 >= self.bytes().len()
• Panics if (offset % 8 != 0) && (offset / 8) + 2 >= self.bytes().len()

pub fn write_u16_be_full(&mut self, v: u16) -> &mut Self

Write a [BE-bit, BE-byte] order u16, panicking on out of bounds, advancing the internal cursor

Panics

• Panics if (self.pos() / 8) + 1 >= self.bytes().len()
• Panics if (self.pos() % 8 != 0) && (self.pos() / 8) + 2 >= self.bytes().len()

impl<S: StorageMut> BitBuf<S>

pub unsafe fn write_be_aligned_full_at_unchecked<T: Write>( &mut self, byte_offset: usize, v: T, ) -> &mut Self

Write a [BE-bit, BE-byte] order type T at byte_offset without performing bound checks

Safety

All semantics of the corresponding function for the type apply

Panics

All semantics of the corresponding function for the type apply

pub unsafe fn write_be_aligned_full_unchecked<T: Write>( &mut self, v: T, ) -> &mut Self

Write a [BE-bit, BE-byte] order type T without performing bound checks, advancing the internal cursor

Safety

All semantics of the corresponding function for the type apply

Panics

All semantics of the corresponding function for the type apply

pub unsafe fn write_be_full_at_unchecked<T: Write>( &mut self, offset: usize, v: T, ) -> &mut Self

Write a [BE-bit, BE-byte] order type T at offset without performing bound checks

Safety

All semantics of the corresponding function for the type apply

Panics

All semantics of the corresponding function for the type apply

pub unsafe fn write_be_full_unchecked<T: Write>(&mut self, v: T) -> &mut Self

Write a [BE-bit, BE-byte] order type T without performing bound checks, advancing the internal cursor

Safety

All semantics of the corresponding function for the type apply

Panics

All semantics of the corresponding function for the type apply

pub fn try_write_be_full_at<T: Write>( &mut self, offset: usize, v: T, ) -> Result<&mut Self>

Write a [BE-bit, BE-byte] order type T at offset while performing bound checks

Errors

All semantics of the corresponding function for the type apply

pub fn try_write_be_full<T: Write>(&mut self, v: T) -> Result<&mut Self>

Write a [BE-bit, BE-byte] order type T while performing bound checks, advancing the internal cursor

Errors

All semantics of the corresponding function for the type apply

pub fn write_be_full_at<T: Write>(&mut self, offset: usize, v: T) -> &mut Self

Write a [BE-bit, BE-byte] order type T at offset, panicking on out of bounds

Panics

All semantics of the corresponding function for the type apply

pub fn write_be_full<T: Write>(&mut self, v: T) -> &mut Self

Write a [BE-bit, BE-byte] order type T, panicking on out of bounds, advancing the internal cursor

Panics

All semantics of the corresponding function for the type apply

Trait Implementations

impl<S: Debug> Debug for BitBuf<S>

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

Formats the value using the given formatter.