Struct wire_rs::VectoredWriter

pub struct VectoredWriter<'a, const E: bool = true> { /* private fields */ }

Implementations

impl<'a, const E: bool> VectoredWriter<'a, E>

pub fn new(bytes: VectoredBufMut<'a>) -> Self

Create a VectoredWriter that can write data types sequentially to the vectored bytes slice.

pub fn advance(&mut self, amount: usize) -> Result<(), WireError>

Advance the writer’s index forward by the given amount of bytes, returning an error if there are insufficient bytes on the wire to do so.

pub fn advance_up_to(&mut self, index: usize)

Advance the writer’s index forward by the given number of bytes, or to the end of the vectored wire if the amount exceeds the number of remaining bytes.

pub fn finalize(&self) -> Result<(), WireError>

Check if the writer has no more bytes left on the vectored wire that can be written to. If any bytes remain, return WireError::ExtraBytes; otherwise, return Ok().

pub fn finalize_after<T>(
    action: Result<(), WireError>,
    reader: &Self
) -> Result<(), WireError>

Check if the writer has no more bytes left on the vectored wire that can be written to after the given action. If any bytes remain, return WireError::ExtraBytes; otherwise, return Ok().

pub fn is_empty(&self) -> bool

Check whether the writer has any remaining bytes that can be written to.

pub fn write<T>(&mut self, writable: &T) -> Result<(), WireError>where
    T: VectoredWrite + ?Sized,

Write the given data type writable to the vectored wire.

pub fn write_part<T, const L: usize>(
    &mut self,
    writable: &T
) -> Result<(), WireError>where
    T: VectoredWritePart,

Write the given data type writable to L bytes on the vectored wire.

Trait Implementations

impl From<VectoredWriter<'_, true>> for WireIndex

fn from(writer: VectoredWriter<'_>) -> Self

Converts to this type from the input type.