Struct IoInput 

pub struct IoInput<R> { /* private fields */ }

Available on crate feature std only.

Input type which supports seekable readers. Uses a BufReader internally to buffer input and avoid unnecessary IO calls.

Only available with the std feature

Implementations

impl<R: Read + Seek> IoInput<R>

pub fn new(reader: R) -> IoInput<R>

Create a new IoReader from a seekable reader.

Trait Implementations

impl<'src, R: Read + Seek + 'src> Input<'src> for IoInput<R>

type Cursor = usize

The type used to keep track of the current location in the stream.

type Span = SimpleSpan

The type of a span on this input.

type Token = u8

The type of singular tokens generated by the input.

type MaybeToken = u8

The token type returned by Input::next_maybe, allowing abstracting over by-value and by-reference inputs.

type Cache = IoInput<R>

A type that contains cached or constant data pertaining to an input.

fn begin(self) -> (Self::Cursor, Self::Cache)

Create an initial cursor and cache at the start of the input.

fn cursor_location(cursor: &Self::Cursor) -> usize

Return the ‘location’ associated with the given cursor.

unsafe fn next_maybe( this: &mut Self::Cache, cursor: &mut Self::Cursor, ) -> Option<Self::MaybeToken>

Pull the next token, if any, from the input.

unsafe fn span( _this: &mut Self::Cache, range: Range<&Self::Cursor>, ) -> Self::Span

Create a span going from the start cursor to the end cursor (exclusive).

fn with_context<S: Span>(self, context: S::Context) -> WithContext<S, Self>

where Self: Sized,

Add extra context within spans generated by this input.

fn map<T, S, F>(self, eoi: S, f: F) -> MappedInput<'src, T, S, Self, F>

where Self: Sized, F: Fn(Self::MaybeToken) -> (<Self::MaybeToken as IntoMaybe<'src, Self::Token>>::Proj<T>, <Self::MaybeToken as IntoMaybe<'src, Self::Token>>::Proj<S>) + 'src, T: 'src, S: Span + 'src,

Map tokens of the input into separate token and span types, using the provided function.

fn split_token_span<T, S>(self, eoi: S) -> MappedInput<'src, T, S, Self>

where Self: Input<'src, Token = (T, S), MaybeToken = &'src (T, S)> + Sized, T: 'src, S: Span + 'src,

Take an input (such as a slice) with token type (T, S) and turns it into one that produces tokens of type T and spans of type S.

fn split_spanned<T, S>(self, eoi: S) -> MappedInput<'src, T, S, Self>

where Self: Input<'src, Token = S::Spanned, MaybeToken = &'src S::Spanned> + Sized, T: 'src, S: WrappingSpan<T> + 'src,

Take an input (such as a slice) with token type T where T is a spanned type, and split it into its inner value and token.

fn map_span<S: Span, F>(self, map_fn: F) -> MappedSpan<S, Self, F>

where Self: Input<'src> + Sized, F: Fn(Self::Span) -> S,

Map the spans output for this input to a different output span.

impl<'src, R: Read + Seek + 'src> ValueInput<'src> for IoInput<R>

unsafe fn next( this: &mut Self::Cache, cursor: &mut Self::Cursor, ) -> Option<Self::Token>

Get the next cursor from the provided one, and the next token if it exists