Struct bitcursor::BitCursor

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

A 'BitCursor' wraps an in memory buffer and provides it with a Seek implementation provided that memory buffer impls the Unit trait

'BitCursors' are used in memory buffers, any slice with types implementing Unit, to allow it to read/write sizes of whatever unit implementation you pass in, starting from the current bit position

It has implementations for some standard library traits such as ['Seek'] ['Read'] ['BufRead']

Examples

use std::io::{Read, Seek, SeekFrom};
use BitCursor;
fn read_from_bits() {
    let data = [
        false, true, true, false, true, false, true, false, true, true, true, true, false,
        false, false, true, false, true, true, true, false, true, false, false,
    ];
    let mut bcurs = BitCursor::new(&data[..]);
    let _ = bcurs.seek(SeekFrom::Start(13));
    let mut buf = vec![0, 0, 0, 0];
    let amt = bcurs.read(&mut buf).unwrap();
    assert_eq!(2, amt);
    assert_eq!(vec![46, 128, 0, 0], Vec::from(buf))
}

Methods

impl<T> BitCursor<T>

Important traits for BitCursor<&'a [T]>

impl<'a, T: Unit> Read for BitCursor<&'a [T]>impl<'a, T: Unit> Read for BitCursor<&'a mut [T]>impl<'a, T: Unit> Read for BitCursor<Vec<T>>impl<'a, T: Unit> Read for BitCursor<&'a Vec<T>>impl<'a, T: Unit> Read for BitCursor<&'a mut Vec<T>>impl<'a, T: Unit> Read for BitCursor<T>

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

Creates a new BitCursor wrapping the provided underlying in-memory buffer.

Initial position for the bitcursor's unit cursor is 0, similarly the bit position will start at 0 Similarly to std::io::Cursor writing to the Bitcursor starts with overwriting vector content, not appending it!

Examples

use BitCursor;

let buff = BitCursor::new(Vec::new());

pub fn into_inner(self) -> T

Consumes the BitCursor, returning the underlying value.

Examples

use BitCursor;

let buff = BitCursor::new(Vec::new());

pub fn get_ref(&self) -> &T

Get a reference to the underlying value in this BitCursor

Examples

use BitCursor;

let buff = BitCursor::new(Vec::new());

let reference = buff.get_ref();

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

Gets a mutable reference to the underlying value in this BitCursor.

Care should be taken to avoid modifying the internal I/O state of the underlying value as it may corrupt this cursor's position.

Examples

use BitCursor;

let mut buff = BitCursor::new(Vec::new());

let reference = buff.get_mut();

pub fn cur_position(&self) -> u64

Returns the current position of this BitCursor.

Examples

use BitCursor;
use std::io::prelude::*;
use std::io::SeekFrom;

let mut buff: BitCursor<Vec<u8>> = BitCursor::new(vec![1, 2, 3, 4, 5]);

assert_eq!(buff.cur_position(), 0);

buff.seek(SeekFrom::Current(16)).unwrap();
assert_eq!(buff.cur_position(), 2);

buff.seek(SeekFrom::Current(-1)).unwrap();
assert_eq!(buff.cur_position(), 1);

pub fn bit_position(&self) -> u8

Returns the current bit position of this BitCursor.

Examples

use BitCursor;
use std::io::prelude::*;
use std::io::SeekFrom;

let mut buff: BitCursor<Vec<u8>> = BitCursor::new(vec![1, 2, 3, 4, 5]);

assert_eq!(buff.bit_position(), 0);

buff.seek(SeekFrom::Current(16)).unwrap();
assert_eq!(buff.bit_position(), 0);

buff.seek(SeekFrom::Current(-1)).unwrap();
assert_eq!(buff.bit_position(), 7);

pub fn set_bit_pos(&mut self, new: u8)

Sets the bit position of this BitCursor. does not wrap to the size of the Unit type also allows going over the length of the BitCursor it's recommended to use std::io::Seek

Examples

use BitCursor;

let mut buff: BitCursor<Vec<u8>> = BitCursor::new(vec![1, 2, 3, 4, 5]);

assert_eq!(buff.position(), 0);

buff.set_bit_pos(2);
assert_eq!(buff.bit_position(), 2);

buff.set_bit_pos(4);
assert_eq!(buff.bit_position(), 4);

pub fn set_cur_pos(&mut self, new: u64)

Sets the position of this BitCursor. also allows going over the length of the BitCursor it's recommended to use std::io::Seek

Examples

use BitCursor;

let mut buff: BitCursor<Vec<u8>> = BitCursor::new(vec![1, 2, 3, 4, 5]);

assert_eq!(buff.cur_position(), 0);

buff.set_cur_pos(2);
assert_eq!(buff.cur_position(), 2);

buff.set_cur_pos(4);
assert_eq!(buff.cur_position(), 4);

Trait Implementations

impl<'a, T: Unit> ReadBits<T> for BitCursor<&'a [T]>

fn read_bits<U: Unit>(&mut self) -> Result<U>

Read the bits of size <T: Unit> starting from the bit position of the cursor

impl<'a, T: Unit> ReadBits<T> for BitCursor<&'a mut [T]>

fn read_bits<U: Unit>(&mut self) -> Result<U>

Read the bits of size <T: Unit> starting from the bit position of the cursor

impl<'a, T: Unit> ReadBits<T> for BitCursor<Vec<T>>

fn read_bits<U: Unit>(&mut self) -> Result<U>

Read the bits of size <T: Unit> starting from the bit position of the cursor

impl<'a, T: Unit> ReadBits<T> for BitCursor<&'a Vec<T>>

fn read_bits<U: Unit>(&mut self) -> Result<U>

Read the bits of size <T: Unit> starting from the bit position of the cursor

impl<'a, T: Unit> ReadBits<T> for BitCursor<&'a mut Vec<T>>

fn read_bits<U: Unit>(&mut self) -> Result<U>

Read the bits of size <T: Unit> starting from the bit position of the cursor

impl<'a, T: Unit> ReadBits<T> for BitCursor<T>

fn read_bits<U: Unit>(&mut self) -> Result<U>

Read the bits of size <T: Unit> starting from the bit position of the cursor

impl<'a, T: Unit> ForceReadBits<T> for BitCursor<&'a [T]>

fn force_read_bits<U: Unit>(&mut self) -> Result<U>

Read the bits of size <T: Unit> starting from the bit position of the cursor

impl<'a, T: Unit> ForceReadBits<T> for BitCursor<&'a mut [T]>

fn force_read_bits<U: Unit>(&mut self) -> Result<U>

Read the bits of size <T: Unit> starting from the bit position of the cursor

impl<'a, T: Unit> ForceReadBits<T> for BitCursor<Vec<T>>

fn force_read_bits<U: Unit>(&mut self) -> Result<U>

Read the bits of size <T: Unit> starting from the bit position of the cursor

impl<'a, T: Unit> ForceReadBits<T> for BitCursor<&'a Vec<T>>

fn force_read_bits<U: Unit>(&mut self) -> Result<U>

Read the bits of size <T: Unit> starting from the bit position of the cursor

impl<'a, T: Unit> ForceReadBits<T> for BitCursor<&'a mut Vec<T>>

fn force_read_bits<U: Unit>(&mut self) -> Result<U>

Read the bits of size <T: Unit> starting from the bit position of the cursor

impl<'a, T: Unit> ForceReadBits<T> for BitCursor<T>

fn force_read_bits<U: Unit>(&mut self) -> Result<U>

Read the bits of size <T: Unit> starting from the bit position of the cursor

impl<T: Clone> Clone for BitCursor<T>

Important traits for BitCursor<&'a [T]>

impl<'a, T: Unit> Read for BitCursor<&'a [T]>impl<'a, T: Unit> Read for BitCursor<&'a mut [T]>impl<'a, T: Unit> Read for BitCursor<Vec<T>>impl<'a, T: Unit> Read for BitCursor<&'a Vec<T>>impl<'a, T: Unit> Read for BitCursor<&'a mut Vec<T>>impl<'a, T: Unit> Read for BitCursor<T>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for BitCursor<T>

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

Formats the value using the given formatter.

impl<'a, T: Unit> Seek for BitCursor<&'a [T]>

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

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

impl<'a, T: Unit> Seek for BitCursor<&'a mut [T]>

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

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

impl<'a, T: Unit> Seek for BitCursor<Vec<T>>

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

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

impl<'a, T: Unit> Seek for BitCursor<&'a Vec<T>>

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

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

impl<'a, T: Unit> Seek for BitCursor<&'a mut Vec<T>>

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

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

impl<'a, T: Unit> Seek for BitCursor<T>

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

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

impl<'a, T: Unit> Read for BitCursor<&'a [T]>

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

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

unsafe fn initializer(&self) -> Initializer

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

Determines if this Reader can work with buffers of uninitialized memory.

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

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

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

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

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

Read the exact number of bytes required to fill buf.

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

Creates a "by reference" adaptor for this instance of Read.

fn bytes(self) -> Bytes<Self>

Transforms this Read instance to an [Iterator] over its bytes.

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

Creates an adaptor which will chain this stream with another.

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

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

impl<'a, T: Unit> Read for BitCursor<&'a mut [T]>

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

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

unsafe fn initializer(&self) -> Initializer

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

Determines if this Reader can work with buffers of uninitialized memory.

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

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

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

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

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

Read the exact number of bytes required to fill buf.

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

Creates a "by reference" adaptor for this instance of Read.

fn bytes(self) -> Bytes<Self>

Transforms this Read instance to an [Iterator] over its bytes.

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

Creates an adaptor which will chain this stream with another.

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

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

impl<'a, T: Unit> Read for BitCursor<Vec<T>>

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

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

unsafe fn initializer(&self) -> Initializer

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

Determines if this Reader can work with buffers of uninitialized memory.

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

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

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

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

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

Read the exact number of bytes required to fill buf.

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

Creates a "by reference" adaptor for this instance of Read.

fn bytes(self) -> Bytes<Self>

Transforms this Read instance to an [Iterator] over its bytes.

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

Creates an adaptor which will chain this stream with another.

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

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

impl<'a, T: Unit> Read for BitCursor<&'a Vec<T>>

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

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

unsafe fn initializer(&self) -> Initializer

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

Determines if this Reader can work with buffers of uninitialized memory.

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

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

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

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

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

Read the exact number of bytes required to fill buf.

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

Creates a "by reference" adaptor for this instance of Read.

fn bytes(self) -> Bytes<Self>

Transforms this Read instance to an [Iterator] over its bytes.

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

Creates an adaptor which will chain this stream with another.

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

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

impl<'a, T: Unit> Read for BitCursor<&'a mut Vec<T>>

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

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

unsafe fn initializer(&self) -> Initializer

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

Determines if this Reader can work with buffers of uninitialized memory.

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

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

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

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

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

Read the exact number of bytes required to fill buf.

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

Creates a "by reference" adaptor for this instance of Read.

fn bytes(self) -> Bytes<Self>

Transforms this Read instance to an [Iterator] over its bytes.

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

Creates an adaptor which will chain this stream with another.

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

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

impl<'a, T: Unit> Read for BitCursor<T>

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

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

unsafe fn initializer(&self) -> Initializer

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

Determines if this Reader can work with buffers of uninitialized memory.

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

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

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

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

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

Read the exact number of bytes required to fill buf.

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

Creates a "by reference" adaptor for this instance of Read.

fn bytes(self) -> Bytes<Self>

Transforms this Read instance to an [Iterator] over its bytes.

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

Creates an adaptor which will chain this stream with another.

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

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

impl<'a> BufRead for BitCursor<&'a [u8]>

fn fill_buf(&mut self) -> Result<&[u8]>

Returns the contents of the internal buffer, filling it with more data from the inner reader if it is empty.

fn consume(&mut self, amt: usize)

Tells this buffer that amt bytes have been consumed from the buffer, so they should no longer be returned in calls to read.

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

Read all bytes into buf until the delimiter byte or EOF is reached.

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

Read all bytes until a newline (the 0xA byte) is reached, and append them to the provided buffer.

fn split(self, byte: u8) -> Split<Self>

Returns an iterator over the contents of this reader split on the byte byte.

fn lines(self) -> Lines<Self>

Returns an iterator over the lines of this reader.

impl<'a> BufRead for BitCursor<&'a mut [u8]>

fn fill_buf(&mut self) -> Result<&[u8]>

Returns the contents of the internal buffer, filling it with more data from the inner reader if it is empty.

fn consume(&mut self, amt: usize)

Tells this buffer that amt bytes have been consumed from the buffer, so they should no longer be returned in calls to read.

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

Read all bytes into buf until the delimiter byte or EOF is reached.

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

Read all bytes until a newline (the 0xA byte) is reached, and append them to the provided buffer.

fn split(self, byte: u8) -> Split<Self>

Returns an iterator over the contents of this reader split on the byte byte.

fn lines(self) -> Lines<Self>

Returns an iterator over the lines of this reader.

impl<'a> BufRead for BitCursor<Vec<u8>>

fn fill_buf(&mut self) -> Result<&[u8]>

Returns the contents of the internal buffer, filling it with more data from the inner reader if it is empty.

fn consume(&mut self, amt: usize)

Tells this buffer that amt bytes have been consumed from the buffer, so they should no longer be returned in calls to read.

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

Read all bytes into buf until the delimiter byte or EOF is reached.

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

Read all bytes until a newline (the 0xA byte) is reached, and append them to the provided buffer.

fn split(self, byte: u8) -> Split<Self>

Returns an iterator over the contents of this reader split on the byte byte.

fn lines(self) -> Lines<Self>

Returns an iterator over the lines of this reader.

impl<'a> BufRead for BitCursor<&'a Vec<u8>>

fn fill_buf(&mut self) -> Result<&[u8]>

Returns the contents of the internal buffer, filling it with more data from the inner reader if it is empty.

fn consume(&mut self, amt: usize)

Tells this buffer that amt bytes have been consumed from the buffer, so they should no longer be returned in calls to read.

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

Read all bytes into buf until the delimiter byte or EOF is reached.

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

Read all bytes until a newline (the 0xA byte) is reached, and append them to the provided buffer.

fn split(self, byte: u8) -> Split<Self>

Returns an iterator over the contents of this reader split on the byte byte.

fn lines(self) -> Lines<Self>

Returns an iterator over the lines of this reader.

impl<'a> BufRead for BitCursor<&'a mut Vec<u8>>

fn fill_buf(&mut self) -> Result<&[u8]>

Returns the contents of the internal buffer, filling it with more data from the inner reader if it is empty.

fn consume(&mut self, amt: usize)

Tells this buffer that amt bytes have been consumed from the buffer, so they should no longer be returned in calls to read.

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

Read all bytes into buf until the delimiter byte or EOF is reached.

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

Read all bytes until a newline (the 0xA byte) is reached, and append them to the provided buffer.

fn split(self, byte: u8) -> Split<Self>

Returns an iterator over the contents of this reader split on the byte byte.

fn lines(self) -> Lines<Self>

Returns an iterator over the lines of this reader.