Struct WordAdapter 

pub struct WordAdapter<W: Word, 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.

Note that the length of adapted files or memory regions must be a multiple of the word length; a nonempty partial-word tail will not be readable.

To provide a sensible value after a failed read of a partial word at the end of a file, word_pos will always return the position of the underlying Seek rounded up to the next multiple of the byte size of W. This approach, however, requires that if you adapt a Seek, its current position must be a multiple of the byte size of W, or the results of word_pos will be shifted by the rounding.

Implementations

impl<W: Word, B> WordAdapter<W, B>

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

Creates a new WordAdapter.

pub fn into_inner(self) -> B

Consumes this adapter and returns the underlying backend.

Trait Implementations

impl<W: Clone + Word, B: Clone> Clone for WordAdapter<W, B>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

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

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

Formats the value using the given formatter.

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

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

type Flat = False

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

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

where B: 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 WordAdapter<W, B>

where B: 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: Word, B: Read> WordRead for WordAdapter<W, B>

where W::Bytes: Default + AsMut<[u8]>,

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, Self::Error>

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

type Error = Error

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

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

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

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

impl<W: Word, B: Write> WordWrite for WordAdapter<W, B>

where W::Bytes: AsRef<[u8]>,

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>

Writes a word and advances the current position.

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

Flushes the stream.