Struct antlr_rust::input_stream::InputStream

pub struct InputStream<Data: Deref> { /* fields omitted */ }

Default rust target input stream.

Since Rust uses UTF-8 format which does not support indexing by char, InputStream<&str> has slightly different index behavior in compare to java runtime when there are non-ASCII unicode characters. If you need it to generate exactly the same indexes as Java runtime, you have to use CodePoint8/16/32BitCharStream, which does not use rusts native str type, so it would do additional conversions and allocations along the way.

Implementations

impl<Data: ?Sized + InputData> InputStream<Box<Data>>

pub fn new_owned(data: Box<Data>) -> Self

Creates new InputStream over owned data

impl<'a, Data: ?Sized> InputStream<&'a Data> where
    Data: InputData, 

pub fn new(data_raw: &'a Data) -> Self

Creates new InputStream over borrowed data

impl<'a, Data: Deref> InputStream<Data> where
    Data::Target: InputData, 

pub fn reset(&mut self)

Resets input stream to start from the beginning of this slice

Trait Implementations

impl<'a, T> CharStream<&'a [T]> for InputStream<&'a [T]> where
    [T]: InputData, 

pub fn get_text(&self, a: isize, b: isize) -> &'a [T]

Returns underlying data piece, either slice or owned copy. Panics if provided indexes are invalid Called by parser only on token intervals. This fact can be used by custom implementations

impl<'a, T> CharStream<Cow<'a, [T]>> for InputStream<&'a [T]> where
    [T]: InputData, 

pub fn get_text(&self, a: isize, b: isize) -> Cow<'a, [T]>

Returns underlying data piece, either slice or owned copy. Panics if provided indexes are invalid Called by parser only on token intervals. This fact can be used by custom implementations

impl<'a, 'b, T> CharStream<Cow<'b, str>> for InputStream<&'a [T]> where
    [T]: InputData, 

pub fn get_text(&self, a: isize, b: isize) -> Cow<'b, str>

Returns underlying data piece, either slice or owned copy. Panics if provided indexes are invalid Called by parser only on token intervals. This fact can be used by custom implementations

impl<'a, T> CharStream<String> for InputStream<&'a [T]> where
    [T]: InputData, 

pub fn get_text(&self, a: isize, b: isize) -> String

Returns underlying data piece, either slice or owned copy. Panics if provided indexes are invalid Called by parser only on token intervals. This fact can be used by custom implementations

impl<'a, T: From<&'a str>> CharStream<T> for InputStream<&'a str>

pub fn get_text(&self, start: isize, stop: isize) -> T

Returns underlying data piece, either slice or owned copy. Panics if provided indexes are invalid Called by parser only on token intervals. This fact can be used by custom implementations

impl<T: From<D::Owned>, D: ?Sized + InputData> CharStream<T> for InputStream<Box<D>>

pub fn get_text(&self, start: isize, stop: isize) -> T

Returns underlying data piece, either slice or owned copy. Panics if provided indexes are invalid Called by parser only on token intervals. This fact can be used by custom implementations

impl<Data: Debug + Deref> Debug for InputStream<Data>

pub fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'a, Data: Deref> IntStream for InputStream<Data> where
    Data::Target: InputData, 

pub fn consume(&mut self)

Consumes the current symbol in the stream. Advances this stream to the next element.

pub fn la(&mut self, offset: isize) -> isize

Lookaheads (or loopbacks if i is negative)

pub fn mark(&mut self) -> isize

After this call subsequent calls to seek must succeed if seek index is greater than mark index

pub fn release(&mut self, _marker: isize)

Releases marker

pub fn index(&self) -> isize

Returns current position of the input stream

pub fn seek(&mut self, index: isize)

Put stream back in state it was when it was in index position

pub fn size(&self) -> isize

Returns the total number of symbols in the stream.

pub fn get_source_name(&self) -> String

Returns name of the source this stream operates over if any

impl<'a, T: ?Sized + 'static> TidAble<'a> for InputStream<&'a T>

type Static = __InputStreamaT_should_never_exist<T>

impl<'a, T: ?Sized + 'static> TidAble<'a> for InputStream<Box<T>>

type Static = __InputStreamBoxT_should_never_exist<T>