Enum EncodeFormat 

pub enum EncodeFormat {
    Json,
    Yaml,
    MessagePack,
    Postcard,
}

A Serde wire format this crate can encode as a bounded stream.

Variants

Json

application/json.

Yaml

application/yaml (RFC 9512).

MessagePack

application/vnd.msgpack, encoded with named fields so the output stays self-describing.

Postcard

application/x-postcard.

Implementations

impl EncodeFormat

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 media-type value to an encodable format.

Parameters are ignored; matching is case-insensitive; documented pre-registration aliases are accepted for YAML and MessagePack.

pub fn encode_vec<T: Serialize>(self, value: &T) -> Result<Vec<u8>, FormatError>

Encode a bounded value into one in-memory buffer.

For payloads that must exist before headers are sent (an error envelope, a small control document). Ordinary payloads stream through EncodeFormat::encode_stream.

Errors

FormatError::Encoding when the value cannot be encoded in this format.

pub fn encode_stream<T>(self, value: T) -> EncodedStream

where T: Serialize + Send + 'static,

Encode an owned value as an asynchronous, bounded chunk stream.

The serializer runs on a blocking worker and hands chunks of at most 64 KiB through a bounded channel, so memory stays O(channel × chunk) regardless of the encoded size and a slow consumer backpressures the serializer instead of buffering. An encoding failure surfaces as a trailing Err item — the stream is never silently truncated.

Must be called from within a Tokio runtime.

Trait Implementations

impl Clone for EncodeFormat

fn clone(&self) -> EncodeFormat

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for EncodeFormat

impl Debug for EncodeFormat

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

Formats the value using the given formatter.

impl Eq for EncodeFormat

impl PartialEq for EncodeFormat

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for EncodeFormat