Struct WordAdapter

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

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, 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 word_pos will be shifted by the rounding.

Implementations§

Source§

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

Source

pub fn new(backend: B) -> Self

Create a new WordAdapter

Source

pub fn into_inner(self) -> B

Trait Implementations§

Source§

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

Source§

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

Returns a copy of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<W: UnsignedInt + FromBytes + ToBytes, B> CopyType for WordAdapter<W, B>
where B: MemSize, PhantomData<W>: MemSize,

Source§

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

Source§

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

Formats the value using the given formatter. Read more
Source§

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

Source§

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, ) -> Result

Source§

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, ) -> Result<(), Error>

Source§

impl<W: UnsignedInt + FromBytes + ToBytes, B> MemSize for WordAdapter<W, B>
where B: MemSize, PhantomData<W>: MemSize,

Source§

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

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

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

Source§

type Error = Error

Source§

type Word = W

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

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

Read a word and advance the current position.
Source§

impl<W: UnsignedInt + ToBytes + FromBytes + FiniteRangeNumber, B: Seek> WordSeek for WordAdapter<W, B>

Source§

type Error = Error

Source§

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

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

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.
Source§

impl<W: UnsignedInt + ToBytes + FromBytes + FiniteRangeNumber, B: Write> WordWrite for WordAdapter<W, B>

Source§

type Error = Error

Source§

type Word = W

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

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

Write a word and advance the current position.
Source§

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

Flush the stream.

Auto Trait Implementations§

§

impl<W, B> Freeze for WordAdapter<W, B>
where B: Freeze,

§

impl<W, B> RefUnwindSafe for WordAdapter<W, B>

§

impl<W, B> Send for WordAdapter<W, B>
where B: Send,

§

impl<W, B> Sync for WordAdapter<W, B>
where B: Sync,

§

impl<W, B> Unpin for WordAdapter<W, B>
where B: Unpin, W: Unpin,

§

impl<W, B> UnwindSafe for WordAdapter<W, B>
where B: UnwindSafe, W: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CastableFrom<T> for T

Source§

fn cast_from(value: T) -> T

Call Self as W
Source§

impl<T, U> CastableInto<U> for T
where U: CastableFrom<T>,

Source§

fn cast(self) -> U

Call W::cast_from(self)
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DowncastableFrom<T> for T

Source§

fn downcast_from(value: T) -> T

Truncate the current UnsignedInt to a possibly smaller size
Source§

impl<T, U> DowncastableInto<U> for T
where U: DowncastableFrom<T>,

Source§

fn downcast(self) -> U

Call W::downcast_from(self)
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> MemDbg for T
where T: MemDbgImpl,

Source§

fn mem_dbg(&self, flags: DbgFlags) -> Result<(), Error>

Writes to stderr debug infos about the structure memory usage, expanding all levels of nested structures.
Source§

fn mem_dbg_on( &self, writer: &mut impl Write, flags: DbgFlags, ) -> Result<(), Error>

Writes to a core::fmt::Write debug infos about the structure memory usage, expanding all levels of nested structures.
Source§

fn mem_dbg_depth(&self, max_depth: usize, flags: DbgFlags) -> Result<(), Error>

Writes to stderr debug infos about the structure memory usage as mem_dbg, but expanding only up to max_depth levels of nested structures.
Source§

fn mem_dbg_depth_on( &self, writer: &mut impl Write, max_depth: usize, flags: DbgFlags, ) -> Result<(), Error>

Writes to a core::fmt::Write debug infos about the structure memory usage as mem_dbg_on, but expanding only up to max_depth levels of nested structures.
Source§

impl<T> Splat<T> for T

Source§

fn splat(value: T) -> T

Source§

impl<T> To<T> for T

Source§

fn to(self) -> T

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> UpcastableFrom<T> for T

Source§

fn upcast_from(value: T) -> T

Extend the current UnsignedInt to a possibly bigger size.
Source§

impl<T, U> UpcastableInto<U> for T
where U: UpcastableFrom<T>,

Source§

fn upcast(self) -> U

Call W::upcast_from(self)
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V