Struct BitCursor

pub struct BitCursor<T> { /* private fields */ }

Implementations

impl<T> BitCursor<T>

pub fn new(inner: T) -> BitCursor<T>

Creates a new cursor wrapping the provided buffer.

Cursor initial position is 0 even if the given buffer is not empty.

pub fn get_mut(&mut self) -> &mut T

Gets a mutable reference to the inner value

pub fn get_ref(&self) -> &T

Gets a reference to the inner value

pub fn into_inner(self) -> T

Consumes the cursor, returning the inner value.

pub fn position(&self) -> u64

Returns the position (in bits since the start) of this cursor.

pub fn set_position(&mut self, pos: u64)

Sets the position of this cursor (in bits since the start)

impl<T> BitCursor<T>

where T: BorrowBits,

pub fn split(&self) -> (&BitSlice<u8, Msb0>, &BitSlice<u8, Msb0>)

Splits the underlying slice at the cursor position and returns each half.

impl<T> BitCursor<T>

where T: BorrowBitsMut,

pub fn split_mut( &mut self, ) -> (&mut BitSlice<BitSafeU8, Msb0>, &mut BitSlice<BitSafeU8, Msb0>)

Splits the underlying slice at the cursor position and returns each half mutably TODO: should we be re-exporting BitSafeU8 in some other way?

Trait Implementations

impl BitBuf for BitCursor<&[u8]>

fn advance_bits(&mut self, count: usize)

Advance the internal cursor of the BitBuf by count bits.

fn remaining_bits(&self) -> usize

Returns the number of bits between the current position and the end of the buffer.

fn chunk_bits(&self) -> &BitSlice<u8, Msb0>

Returns a BitSlice starting at the current position and of length between 0 and BitBuf::remaining. Note that this can return a shorter slice.

fn chunk_bytes(&self) -> &[u8]

Returns a slice of bytes starting at the current position and of length between 0 and BitBuf::remaining_bytes. Note that this can return a shorter slice.

fn byte_aligned(&self) -> bool

Returns whether or not this BitBuf is fully byte-aligned (beginning and end) with the underlying storage.

fn advance_bytes(&mut self, count: usize)

Advance the internal cursor of the BitBuf by count bytes.

fn remaining_bytes(&self) -> usize

Return the number of full bytes between the current position and the end of the buffer.

fn has_remaining_bits(&self) -> bool

Returns true if there are any more bits to consume.

fn has_remaining_bytes(&self) -> bool

Returns true if there are any more cmplete bytes to consume.

fn chain<U>(self, next: U) -> Chain<Self, U>

where U: BitBuf, Self: Sized,

Creates an adaptor which will chain this buffer to another.

fn copy_to_bit_slice(&mut self, dest: &mut BitSlice<u8, Msb0>)

Copy bits from self into dest.

fn try_copy_to_bit_slice( &mut self, dest: &mut BitSlice<u8, Msb0>, ) -> Result<(), Error>

fn copy_to_slice_bytes(&mut self, dest: &mut [u8])

Copy bytes from self into dest. Call should call byte_aligned() beforehand to ensure buffer is fully byte-aligned before calling, call may panic if buffer isn’t byte-aligned.

fn try_copy_to_slice_bytes(&mut self, dest: &mut [u8]) -> Result<(), Error>

Try to copy bytes from self into dest. Returns error if self is not big enough to fill dest or if self is not fully byte-aligned (start and end points both falling on byte boundaries).

fn take_bits(self, limit: usize) -> Take<Self>

where Self: Sized,

Create an adaptor which can read at most limit bits from self.

fn take_bytes(self, limit: usize) -> Take<Self>

where Self: Sized,

Create an adaptor which can read at most limit bytes from self.

impl BitBuf for BitCursor<&BitSlice<u8, Msb0>>

fn advance_bits(&mut self, count: usize)

Advance the internal cursor of the BitBuf by count bits.

fn remaining_bits(&self) -> usize

Returns the number of bits between the current position and the end of the buffer.

fn chunk_bits(&self) -> &BitSlice<u8, Msb0>

Returns a BitSlice starting at the current position and of length between 0 and BitBuf::remaining. Note that this can return a shorter slice.

fn chunk_bytes(&self) -> &[u8]

Returns a slice of bytes starting at the current position and of length between 0 and BitBuf::remaining_bytes. Note that this can return a shorter slice.

fn byte_aligned(&self) -> bool

Returns whether or not this BitBuf is fully byte-aligned (beginning and end) with the underlying storage.

fn advance_bytes(&mut self, count: usize)

Advance the internal cursor of the BitBuf by count bytes.

fn remaining_bytes(&self) -> usize

Return the number of full bytes between the current position and the end of the buffer.

fn has_remaining_bits(&self) -> bool

Returns true if there are any more bits to consume.

fn has_remaining_bytes(&self) -> bool

Returns true if there are any more cmplete bytes to consume.

fn chain<U>(self, next: U) -> Chain<Self, U>

where U: BitBuf, Self: Sized,

Creates an adaptor which will chain this buffer to another.

fn copy_to_bit_slice(&mut self, dest: &mut BitSlice<u8, Msb0>)

Copy bits from self into dest.

fn try_copy_to_bit_slice( &mut self, dest: &mut BitSlice<u8, Msb0>, ) -> Result<(), Error>

fn copy_to_slice_bytes(&mut self, dest: &mut [u8])

Copy bytes from self into dest. Call should call byte_aligned() beforehand to ensure buffer is fully byte-aligned before calling, call may panic if buffer isn’t byte-aligned.

fn try_copy_to_slice_bytes(&mut self, dest: &mut [u8]) -> Result<(), Error>

Try to copy bytes from self into dest. Returns error if self is not big enough to fill dest or if self is not fully byte-aligned (start and end points both falling on byte boundaries).

fn take_bits(self, limit: usize) -> Take<Self>

where Self: Sized,

Create an adaptor which can read at most limit bits from self.

fn take_bytes(self, limit: usize) -> Take<Self>

where Self: Sized,

Create an adaptor which can read at most limit bytes from self.

impl<T> BitRead for BitCursor<T>

where T: BorrowBits,

fn read_bits<O>(&mut self, dest: &mut BitSlice<O, Msb0>) -> Result<usize, Error>

where O: BitStore,

Pull some bits from this source into the specified buffer, returning how many bits were read.

fn read_bits_exact<O>( &mut self, dest: &mut BitSlice<O, Msb0>, ) -> Result<(), Error>

where O: BitStore,

Read the exact number of bits required to fill buf.

impl<T> BitSeek for BitCursor<T>

where T: BorrowBits,

fn bit_seek(&mut self, pos: SeekFrom) -> Result<u64, Error>

impl<T> BitWrite for BitCursor<T>

where T: BorrowBitsMut, BitCursor<T>: Write,

fn write_bits<O>(&mut self, source: &BitSlice<O, Msb0>) -> Result<usize, Error>

where O: BitStore,

Write a buffer into this writer, returning how many bytes were written.

fn write_all_bits<O>(&mut self, source: &BitSlice<O, Msb0>) -> Result<(), Error>

where O: BitStore,

Write the entirety buf into self.

impl<T> Clone for BitCursor<T>

where T: Clone,

fn clone(&self) -> BitCursor<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T> Debug for BitCursor<T>

where T: Debug,

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

Formats the value using the given formatter.

impl<T> Default for BitCursor<T>

where T: Default,

fn default() -> BitCursor<T>

Returns the “default value” for a type.

impl<T> LowerHex for BitCursor<T>

where T: LowerHex,

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

Formats the value using the given formatter.

impl<T> PartialEq for BitCursor<T>

where T: PartialEq,

fn eq(&self, other: &BitCursor<T>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T> Read for BitCursor<T>

where T: BorrowBits,

fn read(&mut self, buf: &mut [u8]) -> Result<usize, Error>

Pull some bytes from this source into the specified buffer, returning how many bytes were read.

fn read_vectored(&mut self, bufs: &mut [IoSliceMut<'_>]) -> Result<usize, Error>

Like read, except that it reads into a slice of buffers.

fn is_read_vectored(&self) -> bool

🔬This is a nightly-only experimental API. (can_vector)

Determines if this Reader has an efficient read_vectored implementation.

fn read_to_end(&mut self, buf: &mut Vec<u8>) -> Result<usize, Error>

Reads all bytes until EOF in this source, placing them into buf.

fn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>

Reads all bytes until EOF in this source, appending them to buf.

fn read_exact(&mut self, buf: &mut [u8]) -> Result<(), Error>

Reads the exact number of bytes required to fill buf.

fn read_buf(&mut self, buf: BorrowedCursor<'_>) -> Result<(), Error>

🔬This is a nightly-only experimental API. (read_buf)

Pull some bytes from this source into the specified buffer.

fn read_buf_exact(&mut self, cursor: BorrowedCursor<'_>) -> Result<(), Error>

🔬This is a nightly-only experimental API. (read_buf)

Reads the exact number of bytes required to fill cursor.

fn by_ref(&mut self) -> &mut Self

where Self: Sized,

Creates a “by reference” adaptor for this instance of Read.

fn bytes(self) -> Bytes<Self>

where Self: Sized,

Transforms this Read instance to an Iterator over its bytes.

fn chain<R>(self, next: R) -> Chain<Self, R>

where R: Read, Self: Sized,

Creates an adapter which will chain this stream with another.

fn take(self, limit: u64) -> Take<Self>

where Self: Sized,

Creates an adapter which will read at most limit bytes from it.

impl<T> Seek for BitCursor<T>

where T: BorrowBits,

fn seek(&mut self, pos: SeekFrom) -> Result<u64, Error>

Seek to an offset, in bytes, in a stream.

fn rewind(&mut self) -> Result<(), Error>

Rewind to the beginning of a stream.

fn stream_len(&mut self) -> Result<u64, Error>

🔬This is a nightly-only experimental API. (seek_stream_len)

Returns the length of this stream (in bytes).

fn stream_position(&mut self) -> Result<u64, Error>

Returns the current seek position from the start of the stream.

fn seek_relative(&mut self, offset: i64) -> Result<(), Error>

Seeks relative to the current position.

impl<T> Write for BitCursor<T>

where T: BorrowBitsMut,

fn write(&mut self, buf: &[u8]) -> Result<usize, Error>

Writes a buffer into this writer, returning how many bytes were written.

fn flush(&mut self) -> Result<(), Error>

Flushes this output stream, ensuring that all intermediately buffered contents reach their destination.

fn write_vectored(&mut self, bufs: &[IoSlice<'_>]) -> Result<usize, Error>

Like write, except that it writes from a slice of buffers.

fn is_write_vectored(&self) -> bool

🔬This is a nightly-only experimental API. (can_vector)

Determines if this Writer has an efficient write_vectored implementation.

fn write_all(&mut self, buf: &[u8]) -> Result<(), Error>

Attempts to write an entire buffer into this writer.

fn write_all_vectored(&mut self, bufs: &mut [IoSlice<'_>]) -> Result<(), Error>

🔬This is a nightly-only experimental API. (write_all_vectored)

Attempts to write multiple buffers into this writer.

fn write_fmt(&mut self, args: Arguments<'_>) -> Result<(), Error>

Writes a formatted string into this writer, returning any error encountered.

fn by_ref(&mut self) -> &mut Self

where Self: Sized,

Creates a “by reference” adapter for this instance of Write.

impl<T> Eq for BitCursor<T>

where T: Eq,

impl<T> StructuralPartialEq for BitCursor<T>