Skip to main content

AsyncYamlStream

Type Alias AsyncYamlStream 

Source
pub type AsyncYamlStream<R, T> = FramedRead<R, YamlDecoder<T>>;
Expand description

A backpressured asynchronous stream of YAML documents.

The reader is consumed through Tokio’s [AsyncRead] contract. Each stream item is parsed only when the consumer polls for it, and source order is preserved. The decoder buffers at most one incomplete document up to its configured frame limit, although an individual read may also contain later complete documents that remain buffered until subsequent polls.

Construct this type with async_yaml_stream or async_yaml_stream_with_config. Consumers can use any compatible StreamExt implementation to await items.

Aliased Type§

pub struct AsyncYamlStream<R, T> { /* private fields */ }