Enum DecodeFormat 

pub enum DecodeFormat {
    Json,
    MessagePack,
    Postcard,
}

A Serde wire format this crate can decode incrementally from a reader, without ever owning the complete input.

Whole-document formats (YAML, TOML) are deliberately absent: their available decoders require the full input in memory, which defeats the bounded-memory contract. Reject them upstream with a typed unsupported-media-type failure instead.

Variants

Json

application/json.

MessagePack

application/vnd.msgpack, self-describing (named fields).

Postcard

application/x-postcard — not self-describing; callers must know the schema out of band.

Implementations

impl DecodeFormat

pub const fn media_type(self) -> &'static str

The format’s canonical media type.

pub const fn name(self) -> &'static str

The format’s display name for error detail.

pub fn from_content_type(content_type: &str) -> Option<Self>

Resolve a Content-Type value to a decodable format.

Parameters (; charset=…) are ignored; matching is case-insensitive. Documented pre-registration aliases are accepted for MessagePack. None means the media type is not an incrementally decodable format.

pub fn decode_slice<T: DeserializeOwned>( self, body: &[u8], ) -> Result<T, FormatError>

Decode a complete in-memory document.

For inputs that are already bounded (a small control message, a test fixture). Streaming inputs go through DecodeFormat::decode_reader.

Errors

FormatError::MalformedDocument with decoder position detail (where the decoder provides it).

pub fn decode_reader<T, R>(self, reader: R) -> Result<T, FormatError>

where T: DeserializeOwned, R: Read,

Decode a document incrementally from reader.

The decoder pulls from the reader as it parses, so the caller never owns the complete input. Run it on a blocking-capable thread when the reader bridges an asynchronous source.

A reader that enforces a size limit should surface the limit hit as io::Error::other(crate::PayloadLimitExceeded); it is reported as FormatError::PayloadTooLarge.

Errors

FormatError::Read / FormatError::PayloadTooLarge when the reader fails, FormatError::MalformedDocument when the input is not a valid document in this format.

Trait Implementations

impl Clone for DecodeFormat

fn clone(&self) -> DecodeFormat

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for DecodeFormat

impl Debug for DecodeFormat

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

Formats the value using the given formatter.

impl Eq for DecodeFormat

impl PartialEq for DecodeFormat

fn eq(&self, other: &DecodeFormat) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for DecodeFormat