Struct dsi_bitstream::impls::MemWordReader

pub struct MemWordReader<W: UnsignedInt, B: AsRef<[W]>, const INF: bool = true> { /* private fields */ }

An implementation of WordRead and WordSeek for a slice.

The implementation depends on the INF parameter: if true, the reader will behave as if the slice is infinitely extended with zeros. If false, the reader will return an error when reading beyond the end of the slice. You can create a zero-extended reader with MemWordReader::new and a strict reader with MemWordReader::new_strict.

The zero-extended reader is usually much faster than the strict reader, but it might loop infinitely when reading beyond the end of the slice.

Examples

use dsi_bitstream::prelude::*;

let words: [u32; 2] = [1, 2];

let mut word_reader = MemWordReader::new(&words);
assert_eq!(1, word_reader.read_word().unwrap());
assert_eq!(2, word_reader.read_word().unwrap());
assert_eq!(0, word_reader.read_word().unwrap());
assert_eq!(0, word_reader.read_word().unwrap());

let mut word_reader = MemWordReader::new_strict(&words);
assert_eq!(1, word_reader.read_word().unwrap());
assert_eq!(2, word_reader.read_word().unwrap());
assert!(word_reader.read_word().is_err());

Implementations

impl<W: UnsignedInt, B: AsRef<[W]>> MemWordReader<W, B>

pub fn new(data: B) -> Self

Create a new MemWordReader from a slice of data

pub fn into_inner(self) -> B

impl<W: UnsignedInt, B: AsRef<[W]>> MemWordReader<W, B, false>

pub fn new_strict(data: B) -> Self

Create a new MemWordReader from a slice of data

Trait Implementations

impl<W: Clone + UnsignedInt, B: Clone + AsRef<[W]>, const INF: bool> Clone for MemWordReader<W, B, INF>

fn clone(&self) -> MemWordReader<W, B, INF>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<W: Debug + UnsignedInt, B: Debug + AsRef<[W]>, const INF: bool> Debug for MemWordReader<W, B, INF>

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

Formats the value using the given formatter.

impl<W: PartialEq + UnsignedInt, B: PartialEq + AsRef<[W]>, const INF: bool> PartialEq for MemWordReader<W, B, INF>

fn eq(&self, other: &MemWordReader<W, B, INF>) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

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

impl<W: UnsignedInt, B: AsRef<[W]>> WordRead for MemWordReader<W, B, true>

type Error = Infallible

type Word = W

The word type (the type of the result of WordRead::read_word).

fn read_word(&mut self) -> Result<W, Infallible>

Read a word and advance the current position.

impl<W: UnsignedInt, B: AsRef<[W]>> WordRead for MemWordReader<W, B, false>

type Error = Error

type Word = W

The word type (the type of the result of WordRead::read_word).

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

Read a word and advance the current position.

impl<W: UnsignedInt, B: AsRef<[W]>> WordSeek for MemWordReader<W, B, true>

type Error = Infallible

fn get_word_pos(&mut self) -> Result<u64, Infallible>

Get the current position in words from the start of the file.

fn set_word_pos(&mut self, word_index: u64) -> Result<(), Infallible>

Set the current position in words from the start of the file to word_pos.

impl<W: UnsignedInt, B: AsRef<[W]>> WordSeek for MemWordReader<W, B, false>

type Error = Error

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

Get the current position in words from the start of the file.

fn set_word_pos(&mut self, word_index: u64) -> Result<(), Error>

Set the current position in words from the start of the file to word_pos.

impl<W: UnsignedInt, B: AsRef<[W]>, const INF: bool> StructuralPartialEq for MemWordReader<W, B, INF>