Struct StreamCharPos

pub struct StreamCharPos<P>
where
    P: UserPosn,
{ /* private fields */ }

This provides the byte offset of a character within a stream, with an associated position that might also accurately provide line and column numbers of the position

This can be used as a PosnInCharStream implementation for a lexer; if crate::LineColumn is used for the generic argument then the lexer will correctly track the line and column of the position of tokens.

Implementations

impl<P> StreamCharPos<P>

where P: UserPosn,

pub fn pos(&self) -> P

Get the descriptive position that Self includes; if that type provides them accurately, this can give the line number and column number of the position

Trait Implementations

impl<P> Clone for StreamCharPos<P>

where P: UserPosn + Clone,

fn clone(&self) -> StreamCharPos<P>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<P> Debug for StreamCharPos<P>

where P: UserPosn + Debug,

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

Formats the value using the given formatter.

impl<P> Default for StreamCharPos<P>

where P: UserPosn + Default,

fn default() -> StreamCharPos<P>

Returns the “default value” for a type.

impl<P> Display for StreamCharPos<P>

where P: UserPosn,

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

Formats the value using the given formatter.

impl<P> Hash for StreamCharPos<P>

where P: UserPosn + Hash,

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<P> PartialEq for StreamCharPos<P>

where P: UserPosn + PartialEq,

fn eq(&self, other: &StreamCharPos<P>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<P> PosnInCharStream for StreamCharPos<P>

where P: UserPosn,

fn byte_ofs(&self) -> usize

Return the byte offset into the stream of the position.

fn move_by_char(self, ch: char) -> Self

Move on by a character

impl<P> UserPosn for StreamCharPos<P>

where P: UserPosn,

fn advance_cols(self, num_bytes: usize, num_chars: usize) -> Self

Advance the state of the stream by a number of bytes and a number of characters; the characters are guaranteed to not be newlines

fn advance_line(self, num_bytes: usize) -> Self

Advance the state of the stream by a number of bytes and to the start of the next line

fn line(&self) -> usize

Return the line number (if supported, else 0)

fn column(&self) -> usize

Return the column number (if supported, else 0)

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

Format self for an error - this can be the same format as Display (if implemented), or Debug, or whatever is desired

impl<P> Copy for StreamCharPos<P>

where P: UserPosn + Copy,

impl<P> Eq for StreamCharPos<P>

where P: UserPosn + Eq,

impl<P> StructuralPartialEq for StreamCharPos<P>

where P: UserPosn,