Struct StreamParser

pub struct StreamParser<'b, R: Reader, C: BitStackConfig = DefaultConfig> { /* private fields */ }

A pull parser that parses JSON from a stream.

Generic over BitStackConfig for configurable nesting depth. It is designed to be used with the Reader trait, which is used to read data from a stream.

Implementations

impl<'b, R: Reader> StreamParser<'b, R, DefaultConfig>

Methods for StreamParser using DefaultConfig

pub fn new(reader: R, buffer: &'b mut [u8]) -> Self

Create a new StreamParser with default configuration

Uses the default BitStack configuration (u32 bucket, u8 counter) for most common use cases.

impl<'b, R: Reader, C: BitStackConfig> StreamParser<'b, R, C>

Methods for StreamParser with custom BitStackConfig

pub fn with_config(reader: R, buffer: &'b mut [u8]) -> Self

Create a new StreamParser with custom configuration

Use this when you need custom BitStack storage types for specific memory or nesting depth requirements.

Example

use picojson::{StreamParser, BitStackStruct, ArrayBitStack};

let reader = JsonReader::new(json);
let mut buffer = [0u8; 256];

// Custom configuration: u64 bucket + u16 counter for deeper nesting
let mut parser = StreamParser::<_, BitStackStruct<u64, u16>>::with_config(reader, &mut buffer);

Trait Implementations

impl<'b, R: Reader, C: BitStackConfig> PullParser for StreamParser<'b, R, C>

fn next_event(&mut self) -> Result<Event<'_, '_>, ParseError>

Returns the next JSON event or an error if parsing fails. Parsing continues until EndDocument is returned or an error occurs.

fn next(&mut self) -> Option<Result<Event<'_, '_>, ParseError>>

Iterator-like method that returns None when parsing is complete. This method returns None when EndDocument is reached, Some(Ok(event)) for successful events, and Some(Err(error)) for parsing errors.