Struct YamlDecoder 

pub struct YamlDecoder<T> { /* private fields */ }

[tokio_util::codec::Decoder] that emits one parsed T per ----delimited YAML document in the byte stream.

Drop this into a [tokio_util::codec::FramedRead] / [tokio_util::codec::FramedWrite] pipeline to plug streaming YAML parsing into a tower service chain. Each decode call returns:

• Ok(Some(T)) — a complete document was found and parsed.
• Ok(None) — no complete document yet; ask for more bytes.
• Err(e) — the next document failed to parse.

The decoder treats --- at column 0 followed by whitespace or end-of-line as the document terminator, matching the YAML 1.2.2 §9.1.2 directive-end grammar.

Implementations

impl<T> YamlDecoder<T>

pub fn new() -> Self

Create a decoder with default ParserConfig limits. The frame-size cap defaults to max_document_length.

pub fn with_config(config: ParserConfig) -> Self

Create a decoder with a caller-supplied ParserConfig.

The stream-wide budgets (max_documents, max_events, max_nodes, max_total_scalar_bytes, max_merge_keys) are charged across every document the decoder yields, not per frame.

pub fn max_frame_size(self, max: usize) -> Self

Set a hard cap on the inter-frame buffer size. When the BytesMut passed to decode exceeds max, the next decode call returns an Error::Io with InvalidData rather than letting the buffer grow without bound.

The configured max_document_length caps a frame too, so a value above it has no effect: a frame the parser would refuse is never buffered in full.

Trait Implementations

impl<T: Clone> Clone for YamlDecoder<T>

fn clone(&self) -> YamlDecoder<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for YamlDecoder<T>

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

Formats the value using the given formatter.

impl<T> Decoder for YamlDecoder<T>

where T: DeserializeOwned + 'static,

type Item = T

The type of decoded frames.

type Error = Error

The type of unrecoverable frame decoding errors.

fn decode(&mut self, src: &mut BytesMut) -> Result<Option<T>, Error>

Attempts to decode a frame from the provided buffer of bytes.

fn decode_eof(&mut self, src: &mut BytesMut) -> Result<Option<T>, Error>

A default method available to be called when there are no more bytes available to be read from the underlying I/O.

fn framed<T>(self, io: T) -> Framed<T, Self>

where T: AsyncRead + AsyncWrite, Self: Sized,

Provides a Stream and Sink interface for reading and writing to this Io object, using Decode and Encode to read and write the raw data.

impl<T> Default for YamlDecoder<T>

fn default() -> Self

Returns the “default value” for a type.