Struct ByteStream 

pub struct ByteStream<B = Vec<u8>> { /* private fields */ }

A CharStream backed by raw bytes, where each byte is one symbol in 0..=255 and the stream index is the byte offset.

Generic over the backing store B: AsRef<[u8]>: use Vec<u8> for owned bytes or &[u8] to borrow an existing buffer zero-copy. See the module documentation for how this maps onto Rust IO primitives.

Implementations

impl ByteStream<Vec<u8>>

pub fn from_reader(reader: impl Read) -> Result<Self>

Creates a byte stream by draining a std::io::Read into an owned buffer — the bridge for files, sockets, stdin, and std::io::Cursor.

Errors

Returns any error produced while reading reader to end.

impl<B: AsRef<[u8]>> ByteStream<B>

pub fn new(bytes: B) -> Self

Creates a byte stream over bytes, using ANTLR’s unknown source-name placeholder.

bytes may be an owned Vec<u8> or a borrowed &[u8] (zero-copy).

pub fn with_source_name(bytes: B, source_name: impl Into<String>) -> Self

Creates a byte stream with an explicit source name for tokens and diagnostics.

pub fn bytes(&self) -> &[u8]

Returns the backing bytes.

pub fn is_eof(&self) -> bool

Returns true when the cursor has reached or passed the end of input.

Trait Implementations

impl<B: AsRef<[u8]>> CharStream for ByteStream<B>

fn text(&self, interval: TextInterval) -> String

Renders the inclusive byte interval as a lowercase, separator-free hex string. See the module documentation for the rationale.

fn position_summary(&self, start: usize, end: usize) -> Option<PositionSummary>

Summarizes line/column movement over [start, end) by scanning the raw bytes.

Without this, BaseLexer would fall back to iterating Self::text, which is hex — so a span of N bytes would count as 2N columns and 0x0A newline bytes would be invisible, corrupting the line/column of split or synthesized tokens.

fn symbol_at(&self, index: usize) -> Option<i32>

Reads one Unicode scalar at an absolute character index without moving the stream cursor.

fn byte_interval(&self, interval: TextInterval) -> Option<(usize, usize)>

fn contiguous_ascii(&self) -> Option<&[u8]>

Returns the complete input as ASCII bytes when character and byte indexes are identical.

fn source_text(&self) -> Option<Rc<str>>

Returns the complete backing UTF-8 source when it can be shared with a token store.

fn text_source_interval( &self, _interval: TextInterval, ) -> Option<(Rc<str>, usize, usize)>

impl<B: Clone> Clone for ByteStream<B>

fn clone(&self) -> ByteStream<B>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<B: Debug> Debug for ByteStream<B>

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

Formats the value using the given formatter.

impl<B: AsRef<[u8]>> IntStream for ByteStream<B>

fn consume(&mut self)

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

fn index(&self) -> usize

fn seek(&mut self, index: usize)

fn size(&self) -> usize

fn source_name(&self) -> &str

fn mark(&mut self) -> isize

fn release(&mut self, _marker: isize)