Trait rsonpath_lib::depth::DepthIterator

pub trait DepthIterator<'a, I: QuoteClassifiedIterator<'a>>: Iterator<Item = Self::Block> + 'a {
    type Block: DepthBlock<'a>;

    fn resume(
        state: ResumeClassifierState<'a, I>,
        opening: u8
    ) -> (Option<Self::Block>, Self);
    fn stop(self, block: Option<Self::Block>) -> ResumeClassifierState<'a, I>;
}

Trait for depth iterators, i.e. finite iterators returning depth information about JSON documents.

Required Associated Types

type Block: DepthBlock<'a>

Type of the DepthBlock implementation used by this iterator.

Required Methods

fn resume(
    state: ResumeClassifierState<'a, I>,
    opening: u8
) -> (Option<Self::Block>, Self)

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 stop(self, block: Option<Self::Block>) -> ResumeClassifierState<'a, I>

Resume classification from a state retrieved by a previous DepthIterator::stop or StructuralIterator::stop invocation.

Implementors