Struct MemWordWriterVec 

pub struct MemWordWriterVec<W: Word, B> { /* private fields */ }

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

The vector will be extended as new data is written.

Examples

use dsi_bitstream::prelude::*;

let mut words: Vec<u64> = vec![
    0x0043b59fcdf16077,
];

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

// the stream is read sequentially
assert_eq!(word_writer.word_pos()?, 0);
assert!(word_writer.write_word(0).is_ok());
assert_eq!(word_writer.word_pos()?, 1);
assert!(word_writer.write_word(1).is_ok());
assert_eq!(word_writer.word_pos()?, 2);

Implementations

impl<W: Word, B: AsRef<Vec<W>>> MemWordWriterVec<W, B>

pub const fn new(data: B) -> Self

Creates a new MemWordWriterVec from a vector.

pub fn len(&self) -> usize

Returns the number of words in the underlying vector.

pub fn is_empty(&self) -> bool

Returns true if the underlying vector is empty.

pub fn into_inner(self) -> B

Consumes this writer and returns the underlying data.

Trait Implementations

impl<W: Debug + Word, B: Debug> Debug for MemWordWriterVec<W, B>

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

Formats the value using the given formatter.

impl<W: Default + Word, B: Default> Default for MemWordWriterVec<W, B>

fn default() -> MemWordWriterVec<W, B>

Returns the “default value” for a type.

impl<W: Word, B> FlatType for MemWordWriterVec<W, B>

where B: MemSize + FlatType, usize: MemSize + FlatType, PhantomData<W>: MemSize + FlatType,

type Flat = False

Whether the type is flat (True) or not (False).

impl<W: Word, B> MemDbgImpl for MemWordWriterVec<W, B>

where B: MemDbgImpl + FlatType, usize: MemDbgImpl + FlatType, PhantomData<W>: MemDbgImpl + FlatType,

fn _mem_dbg_rec_on( &self, _memdbg_writer: &mut impl Write, _memdbg_total_size: usize, _memdbg_max_depth: usize, _memdbg_prefix: &mut String, _memdbg_is_last: bool, _memdbg_flags: DbgFlags, _memdbg_refs: &mut HashSet<usize>, ) -> Result

Recursively displays the fields of self below the current line.

fn _mem_dbg_depth_on( &self, writer: &mut impl Write, total_size: usize, max_depth: usize, prefix: &mut String, field_name: Option<&str>, is_last: bool, padded_size: usize, flags: DbgFlags, dbg_refs: &mut HashSet<usize>, ) -> Result<(), Error>

Displays self at the given depth without any reference-address annotation; forwards to _mem_dbg_depth_on_impl with RefDisplay::None.

fn _mem_dbg_depth_on_impl( &self, writer: &mut impl Write, total_size: usize, max_depth: usize, prefix: &mut String, field_name: Option<&str>, is_last: bool, padded_size: usize, flags: DbgFlags, dbg_refs: &mut HashSet<usize>, ref_display: RefDisplay, ) -> Result<(), Error>

Internal implementation for depth display.

impl<W: Word, B> MemSize for MemWordWriterVec<W, B>

where B: MemSize + FlatType, usize: MemSize + FlatType, PhantomData<W>: MemSize + FlatType,

fn mem_size_rec( &self, _memsize_flags: SizeFlags, _memsize_refs: &mut HashMap<usize, usize>, ) -> usize

Recursive implementation that tracks visited references for deduplication.

fn mem_size(&self, flags: SizeFlags) -> usize

Returns the (recursively computed) overall memory size of the structure in bytes.

impl<W: PartialEq + Word, B: PartialEq> PartialEq for MemWordWriterVec<W, B>

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

Equality operator ==.

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

Inequality operator !=.

impl<W: PartialEq + Word, B: PartialEq> StructuralPartialEq for MemWordWriterVec<W, B>

impl<W: Word, B: AsRef<Vec<W>>> WordRead for MemWordWriterVec<W, B>

Available on crate feature alloc only.

type Error = WordError

type Word = W

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

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

Reads a word and advances the current position.

fn read_word_opt(&mut self) -> Option<Self::Word>

Reads and consumes the next word if the backend can determine cheaply that one is available, returning None otherwise (in particular, at the end of the stream, or when availability cannot be determined without blocking or performing I/O).

impl<W: Word, B: AsRef<Vec<W>>> WordSeek for MemWordWriterVec<W, B>

Available on crate feature alloc only.

type Error = WordError

fn word_pos(&mut self) -> Result<u64, WordError>

Gets the current position in words from the start of the stream.

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

Sets the current position in words from the start of the stream to word_pos.

impl<W: Word, B: AsMut<Vec<W>>> WordWrite for MemWordWriterVec<W, B>

Available on crate feature alloc only.

type Error = Infallible

type Word = W

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

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

Writes a word and advances the current position.

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

Flushes the stream.