Struct dsi_bitstream::impls::MemWordWriterSlice

pub struct MemWordWriterSlice<W: UnsignedInt, B: AsMut<[W]>> { /* private fields */ }

An implementation of WordRead, WordWrite, and WordSeek for a mutable slice.

Writing beyond the end of the slice will return an error.

Example

use dsi_bitstream::prelude::*;

let mut words: [u64; 2] = [
    0x0043b59fcdf16077,
    0x702863e6f9739b86,
];

let mut word_writer = MemWordWriterSlice::new(&mut words);

// the stream is read sequentially
assert_eq!(word_writer.get_word_pos().unwrap(), 0);
assert_eq!(word_writer.read_word().unwrap(), 0x0043b59fcdf16077);
assert_eq!(word_writer.get_word_pos().unwrap(), 1);
assert_eq!(word_writer.read_word().unwrap(), 0x702863e6f9739b86);
assert_eq!(word_writer.get_word_pos().unwrap(), 2);
assert!(word_writer.read_word().is_err());

// you can change position
assert!(word_writer.set_word_pos(1).is_ok());
assert_eq!(word_writer.get_word_pos().unwrap(), 1);
assert_eq!(word_writer.read_word().unwrap(), 0x702863e6f9739b86);

// errored set position doesn't change the current position
assert_eq!(word_writer.get_word_pos().unwrap(), 2);
assert!(word_writer.set_word_pos(100).is_err());
assert_eq!(word_writer.get_word_pos().unwrap(), 2);

// we can write and read back!
assert!(word_writer.set_word_pos(0).is_ok());
assert!(word_writer.write_word(0x0b801b2bf696e8d2).is_ok());
assert_eq!(word_writer.get_word_pos().unwrap(), 1);
assert!(word_writer.set_word_pos(0).is_ok());
assert_eq!(word_writer.read_word().unwrap(), 0x0b801b2bf696e8d2);
assert_eq!(word_writer.get_word_pos().unwrap(), 1);

Implementations

impl<W: UnsignedInt, B: AsMut<[W]> + AsRef<[W]>> MemWordWriterSlice<W, B>

pub fn new(data: B) -> Self

Create a new MemWordWriterSlice from a slice of ZERO INITIALIZED data

pub fn len(&self) -> usize

pub fn is_empty(&self) -> bool

Trait Implementations

impl<W: Debug + UnsignedInt, B: Debug + AsMut<[W]>> Debug for MemWordWriterSlice<W, B>

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

Formats the value using the given formatter.

impl<W: PartialEq + UnsignedInt, B: PartialEq + AsMut<[W]>> PartialEq for MemWordWriterSlice<W, B>

fn eq(&self, other: &MemWordWriterSlice<W, B>) -> 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: AsMut<[W]>> WordRead for MemWordWriterSlice<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, B: AsRef<[W]> + AsMut<[W]>> WordSeek for MemWordWriterSlice<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, B: AsMut<[W]>> WordWrite for MemWordWriterSlice<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.

impl<W: UnsignedInt, B: AsMut<[W]>> StructuralPartialEq for MemWordWriterSlice<W, B>