Struct ByteWriter

pub struct ByteWriter<W: AsyncWrite + Unpin + Send + Sync, E: Endianness> { /* private fields */ }

For writing aligned bytes to a stream of bytes in a given endianness.

This only writes aligned values and maintains no internal state.

Implementations

impl<W: AsyncWrite + Unpin + Send + Sync, E: Endianness> ByteWriter<W, E>

pub fn new(writer: W) -> ByteWriter<W, E>

Wraps a ByteWriter around something that implements Write

pub fn endian(writer: W, _endian: E) -> ByteWriter<W, E>

Wraps a BitWriter around something that implements Write with the given endianness.

pub fn into_writer(self) -> W

Unwraps internal writer and disposes of ByteWriter. Any unwritten partial bits are discarded.

pub fn writer(&mut self) -> &mut W

Provides mutable reference to internal writer.

pub fn into_bitwriter(self) -> BitWriter<W, E>

Converts ByteWriter to BitWriter in the same endianness.

pub fn bitwriter(&mut self) -> BitWriter<&mut W, E>

Provides temporary BitWriter in the same endianness.

Warning

Any unwritten bits left over when BitWriter is dropped are lost.

Trait Implementations

impl<W: AsyncWrite + Unpin + Send + Sync, E: Endianness> ByteWrite for ByteWriter<W, E>

fn write<'life0, 'async_trait, N>( &'life0 mut self, value: N, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where N: 'async_trait + Numeric, Self: 'async_trait, 'life0: 'async_trait,

Writes whole numeric value to stream

fn write_bytes<'life0, 'life1, 'async_trait>( &'life0 mut self, buf: &'life1 [u8], ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Writes the entirety of a byte buffer to the stream.