Struct Reader

pub struct Reader<T, const BUFFER_SIZE: usize = BYTE_BUFFER_SIZE> { /* private fields */ }

A generic UTF-8 character reader for lexers.

The generic parameter BUFFER_SIZE specifies the size of the internal buffer of Reader.

Reader always tries to read UTF-8 characters from the stream. If there are no valid UTF-8 characters, Reader will return a fatal error (Error::Fatal).

Implementations

impl<T, const BUFFER_SIZE: usize> Reader<T, BUFFER_SIZE>

pub fn new(reader: T, file_type: FileType) -> Self

Creates a new reader with the given inner reader and file type.

impl<T> Reader<T>

pub fn into_inner(self) -> T

Converts the reader into its inner reader.

impl Reader<File>

pub fn from_path<P>(path: P) -> Result<Self>

where P: AsRef<Path> + Clone,

Creates a new reader from the file at the given path.

impl Reader<Stdin>

pub fn from_stdin() -> Self

Creates a new reader from the standard input.

Trait Implementations

impl<'a> From<&'a [u8]> for Reader<&'a [u8]>

fn from(b: &'a [u8]) -> Self

Creates a new reader from the given &[u8].

impl<'a> From<&'a str> for Reader<Cursor<&'a str>>

fn from(s: &'a str) -> Self

Creates a new reader from the given &str.

impl From<Stdin> for Reader<Stdin>

fn from(stdin: Stdin) -> Self

Creates a new reader from the standard input.

impl From<String> for Reader<Cursor<String>>

fn from(s: String) -> Self

Creates a new reader from the given String.

impl<T> InputStream for Reader<T>

where T: Read,

type CharType = char

The type of the character produced by the input stream.

fn next_char_loc(&mut self) -> Result<(Option<char>, Location)>

Reads the next character from the input stream.

fn unread(&mut self, last: (Option<char>, Location))

Unreads the given character and the last location and put it back to the input stream.

fn span(&self) -> &Span

Returns a reference to the current span in the lexer.

fn set_line_col(&mut self, line: u32, col: u32)

Sets the line and column of the current span.

fn peek(&mut self) -> Result<Option<char>>

Peeks the next character from the input stream.

fn peek_with_span(&mut self) -> Result<(Option<char>, Span)>

Peeks the next character from the input stream. Returns the peeked character and its span.

fn next_char(&mut self) -> Result<Option<Self::CharType>>

Reads the next character from the input stream.

fn next_char_span(&mut self) -> Result<(Option<Self::CharType>, Span)>

Reads the next character from the input stream.

fn next_span(&mut self) -> Result<&Span>

Reads the next character from the input stream.

fn skip_until<F>(&mut self, f: F) -> Result<()>

where Self::CharType: Clone, F: FnMut(Self::CharType) -> bool,

Skips characters until a character specified by the predicate is encountered.

fn collect_until<F>(&mut self, f: F) -> Result<Vec<Self::CharType>>

where Self::CharType: Clone, F: FnMut(&Self::CharType) -> bool,

Collects characters into a vector until a character specified by the predicate is encountered.

fn collect_with_span_until<F>( &mut self, f: F, ) -> Result<(Vec<Self::CharType>, Span)>

where Self::CharType: Clone, F: FnMut(&Self::CharType) -> bool,

Collects characters into a vector until a character specified by the predicate is encountered.