Struct sn::Stream

pub struct Stream<'a, T> { /* fields omitted */ }

A data stream. Used by the Parser to iterate over the supplied JSON data and to parse it into Values.

Implementations

impl<'a, T: Copy> Stream<'a, T>

pub fn current_copied(&self) -> Option<T>

Returns the current character.

pub fn current_unchecked(&self) -> T

Returns the current element and panicks if it’s out of range

pub fn next_copied(&mut self) -> Option<T>

Moves to the next character and returns it.

pub fn peek_back_copied(&self) -> Option<T>

Returns a reference to the perevious entry in the stream

impl<'a, T: Eq + Copy> Stream<'a, T>

pub fn next_if_current_is(&mut self, expect: T) -> Option<T>

Returns the current character and moves to the next character if the character matches the provided input.

pub fn next_if_current_present_in(&mut self, expect: &[T]) -> Option<T>

Returns the current character and moves to the next character if the character exists in the provided array.

pub fn skip_if_current_is(&mut self, expect: T) -> bool

Skips the current character if it matches the input, and returns true in this case. Returns false and does not skip if the current character does not match the input.

impl<'a, T> Stream<'a, T>

pub fn new(data: &'a [T]) -> Stream<'_, T>

Creates a new stream

pub fn current(&self) -> Option<&T>

Returns the current element

pub fn is_eof(&self) -> bool

Checks whether the stream has reached the end

pub fn length(&self) -> usize

Get the length of the stream.

pub fn next_entry(&mut self) -> Option<&T>

Returns the next element

pub fn next_unchecked(&mut self) -> &T

Returns the next element and panicks if it’s out of bounds

pub fn peek(&self) -> Option<&T>

Returns a reference to the next entry in the stream

pub fn peek_back(&self) -> Option<&T>

Returns a reference to the previous entry in the stream

pub fn position(&self) -> usize

The current position of the stream on the data

pub fn skip(&mut self)

Skips the current character and moves on to the next one

pub fn skip_n(&mut self, n: usize)

Skips n amount of characters

pub fn unskip(&mut self)

Moves back to the previous character

pub fn slice(&self, from: usize, to: usize) -> &'a [T]

Returns a subslice of this stream but also checks stream length to prevent out of bounds panicking

pub fn slice_unchecked(&self, from: usize, to: usize) -> &'a [T]

Returns a subslice of this stream

pub fn slice_len(&self, from: usize, len: usize) -> &'a [T]

Same as slice, but the second argument is how many elements to slice