Struct dsi_bitstream::impls::WordAdapter

pub struct WordAdapter<W: UnsignedInt + FromBytes + ToBytes, B> { /* private fields */ }

An adapter from Read, Write, and Seek, to WordRead, WordWrite, and WordSeek, respectively.

Instances of this struct can be created using WordAdapter::new. They turn every standard (possibly seekable) source or destination of bytes (such as std::fs::File, std::io::BufReader, sockets, etc.) into a source or destination of words.

Due to the necessity of managing files whose length is not a multiple of the word length, read_word will return a partially read word extended with zeros at the end of such files.

To provide a sensible value after such a read, get_word_pos will always return the position of the underlying Seek rounded up to the next multiple of W::Bytes. This approach, however, requires that if you adapt a Seek, its current position must be a multiple of W::Bytes, or the results of get_word_pos will be shifted by the rounding.

Implementations

impl<W: UnsignedInt + FromBytes + ToBytes, B> WordAdapter<W, B>

pub fn new(backend: B) -> Self

Create a new WordAdapter

pub fn into_inner(self) -> B

Trait Implementations

impl<W: Clone + UnsignedInt + FromBytes + ToBytes, B: Clone> Clone for WordAdapter<W, B>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<W: UnsignedInt + ToBytes + FromBytes + FiniteRangeNumber, B: Read> WordRead for WordAdapter<W, B>

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 + ToBytes + FromBytes + FiniteRangeNumber, B: Seek> WordSeek for WordAdapter<W, B>

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 + ToBytes + FromBytes + FiniteRangeNumber, B: Write> WordWrite for WordAdapter<W, B>

type Error = Error

type Word = W

The word type (the type of the argument of WordWrite::write_word).

fn write_word(&mut self, word: W) -> Result<(), Error>

Write a word and advance the current position.

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

Flush the stream.