Skip to main content

IoEncoder

Struct IoEncoder 

Source
pub struct IoEncoder<W: Write> { /* private fields */ }
Available on crate feature std only.
Expand description

Streaming encoder that writes directly into any Write-shaped sink.

Each IoEncoder::write call calls into the underlying writer for the bytes the type produces. The encoder does not buffer; if you wrap a raw socket / file, wrap it in a std::io::BufWriter first.

§Examples

use pack_io::IoEncoder;

let mut sink: Vec<u8> = Vec::new();
let mut enc = IoEncoder::new(&mut sink);
enc.write(&42_u64).unwrap();
enc.write(&"hello").unwrap();
assert!(!sink.is_empty());

Implementations§

Source§

impl<W: Write> IoEncoder<W>

Source

pub fn new(writer: W) -> Self

Wrap writer in an encoder.

Source

pub fn writer(&self) -> &W

Borrow the underlying writer.

Source

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

Borrow the underlying writer mutably.

Source

pub fn into_inner(self) -> W

Consume the encoder and return the underlying writer.

Source

pub fn write<T: Serialize + ?Sized>(&mut self, value: &T) -> Result<()>

Encode value straight into the underlying writer.

§Errors

Trait Implementations§

Source§

impl<W: Debug + Write> Debug for IoEncoder<W>

Source§

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

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

impl<W: Write> Encode for IoEncoder<W>

Source§

fn write_byte(&mut self, byte: u8) -> Result<()>

Append a single byte. Read more
Source§

fn write_bytes(&mut self, bytes: &[u8]) -> Result<()>

Append a slice of bytes. Read more
Source§

fn reserve(&mut self, additional: usize)

Hint that the caller is about to write additional more bytes. Read more
Source§

fn write_varint_u64(&mut self, value: u64) -> Result<()>

Append a u64 as an unsigned LEB128 varint (1–10 bytes). Read more
Source§

fn write_varint_u128(&mut self, value: u128) -> Result<()>

Append a u128 as an unsigned LEB128 varint (1–19 bytes). Read more

Auto Trait Implementations§

§

impl<W> Freeze for IoEncoder<W>
where W: Freeze,

§

impl<W> RefUnwindSafe for IoEncoder<W>
where W: RefUnwindSafe,

§

impl<W> Send for IoEncoder<W>
where W: Send,

§

impl<W> Sync for IoEncoder<W>
where W: Sync,

§

impl<W> Unpin for IoEncoder<W>
where W: Unpin,

§

impl<W> UnsafeUnpin for IoEncoder<W>
where W: UnsafeUnpin,

§

impl<W> UnwindSafe for IoEncoder<W>
where 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> 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, 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.