Struct StreamDeserializer 

pub struct StreamDeserializer { /* private fields */ }

Reads a stream of YAML documents (see deser::stream).

A document ends where the next one starts (at a --- line) or at a document end marker (...). When reading a stream that stays open (for instance a socket), the writer should end every document with ... (see SerializerConfig::set_end_documents), otherwise a document is only complete once the next one starts. Comments and directives before a document belong to it.

use deser_yaml::DeserializerConfig;

let mut reader =
    DeserializerConfig::new().reader(&b"--- a\n--- b\n"[..]);
assert_eq!(reader.read::<String>().unwrap().as_deref(), Some("a"));
assert_eq!(reader.read::<String>().unwrap().as_deref(), Some("b"));
assert_eq!(reader.read::<String>().unwrap(), None);

Documents are parsed like with a Deserializer, so they can borrow from the stream’s buffer (see InputBuffer::deserialize). Errors (including syntax errors) only discard their document, reading continues with the next one.

Implementations

impl StreamDeserializer

pub fn new() -> StreamDeserializer

Creates a stream deserializer.

pub fn with_config(config: DeserializerConfig) -> StreamDeserializer

Creates a stream deserializer with the given configuration.

pub fn config(&self) -> &DeserializerConfig

Returns the configuration.

Trait Implementations

impl Debug for StreamDeserializer

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

Formats the value using the given formatter.

impl Default for StreamDeserializer

fn default() -> StreamDeserializer

Returns the “default value” for a type.

impl StreamDeserializer for StreamDeserializer

fn context(&self) -> Context

Returns the context the values are deserialized in.

fn frame(&mut self, input: &[u8], eof: bool) -> Result<Frame, Error>

Finds the next value in the input.

fn drive_frame<'de>( &mut self, frame: &'de [u8], driver: &mut DeserializeDriver<'_, 'de>, ) -> Result<(), Error>

Deserializes a value from its frame.

fn is_text(&self) -> bool

Returns true if the format is text.

fn supports_partial(&self) -> bool

Returns true if the deserializer implements drive_partial.

fn drive_partial( &mut self, input: &[u8], offset: usize, eof: bool, driver: &mut DeserializeDriver<'_, '_>, ) -> Result<Progress, Error>

Deserializes a value while its input arrives.

fn peek(&mut self, input: &[u8], eof: bool) -> Result<Option<Progress>, Error>

Finds the start of the next value without deserializing it.