Struct ciborium_ll::Encoder

pub struct Encoder<W: Write>(/* private fields */);

An encoder for serializing CBOR items

This structure wraps a writer and provides convenience functions for writing Header objects to the wire.

Implementations

impl<W: Write> Encoder<W>

pub fn push(&mut self, header: Header) -> Result<(), W::Error>

Push a Header to the wire

pub fn bytes( &mut self, value: &[u8], segment: impl Into<Option<usize>> ) -> Result<(), W::Error>

Serialize a byte slice as CBOR

Optionally, segment the output into segment size segments. Note that if segment == Some(0) it will be silently upgraded to Some(1). This minimum value is highly inefficient and should not be relied upon.

pub fn text( &mut self, value: &str, segment: impl Into<Option<usize>> ) -> Result<(), W::Error>

Serialize a string slice as CBOR

Optionally, segment the output into segment size segments. Note that since care is taken to ensure that each segment is itself a valid UTF-8 string, if segment contains a value of less than 4, it will be silently upgraded to 4. This minimum value is highly inefficient and should not be relied upon.

Trait Implementations

impl<W: Write> From<W> for Encoder<W>

fn from(value: W) -> Self

Converts to this type from the input type.

impl<W: Write> Write for Encoder<W>

type Error = <W as Write>::Error

The error type

fn write_all(&mut self, data: &[u8]) -> Result<(), Self::Error>

Writes all bytes from data or fails

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

Flushes all output