Trait StructuralIterator

pub trait StructuralIterator<'i, I, Q, M, const N: usize>: FallibleIterator<Item = Structural, Error = InputError>
where
    I: InputBlockIterator<'i, N>,
{
    // Required methods
    fn stop(self) -> ResumeClassifierState<'i, I, Q, M, N>;
    fn resume(state: ResumeClassifierState<'i, I, Q, M, N>) -> Self;
    fn turn_colons_off(&mut self);
    fn turn_colons_on(&mut self, idx: usize);
    fn turn_commas_off(&mut self);
    fn turn_commas_on(&mut self, idx: usize);
    fn turn_colons_and_commas_on(&mut self, idx: usize);
    fn turn_colons_and_commas_off(&mut self);
}

Trait for classifier iterators, i.e. finite iterators of Structural characters that hold a reference to the JSON document valid for 'a.

Required Methods

fn stop(self) -> ResumeClassifierState<'i, I, Q, M, N>

Stop classification and return a state object that can be used to resume a classifier from the place in which the current one was stopped.

fn resume(state: ResumeClassifierState<'i, I, Q, M, N>) -> Self

Resume classification from a state retrieved by stopping a classifier.

fn turn_colons_off(&mut self)

Turn classification of Structural::Colon characters off.

fn turn_colons_on(&mut self, idx: usize)

Turn classification of Structural::Colon characters on.

The idx passed should be the index of the byte in the input from which commas are to be classified. Passing an idx that does not match the index which the internal QuoteClassifiedIterator reached may result in incorrect results.

fn turn_commas_off(&mut self)

Turn classification of Structural::Comma characters off.

fn turn_commas_on(&mut self, idx: usize)

Turn classification of Structural::Comma characters on.

The idx passed should be the index of the byte in the input from which commas are to be classified. Passing an idx that does not match the index which the internal QuoteClassifiedIterator reached may result in incorrect results.

fn turn_colons_and_commas_on(&mut self, idx: usize)

Turn classification of both Structural::Comma and Structural::Colon characters on. This is generally faster than calling turn_colons_on and turn_commas_on in sequence.

fn turn_colons_and_commas_off(&mut self)

Turn classification of both Structural::Comma and Structural::Colon characters off. This is generally faster than calling turn_colons_on and turn_commas_on in sequence.

Dyn Compatibility

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementors