Struct LineColumn

pub struct LineColumn { /* private fields */ }

A line and column within a text stream

This provides the UserPosn trait, which provides methods to retrieve the line and column values of the state. This can be used as the ‘State’ type for a lexer, allowing the line and column of tokens to be tracked, and hence lexer tokens can be formmatted in a user-friendly fashion.

Trait Implementations

impl Clone for LineColumn

fn clone(&self) -> LineColumn

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for LineColumn

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

Formats the value using the given formatter.

impl Default for LineColumn

fn default() -> Self

Returns the “default value” for a type.

impl Display for LineColumn

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

Formats the value using the given formatter.

impl Hash for LineColumn

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 PartialEq for LineColumn

fn eq(&self, other: &LineColumn) -> 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 UserPosn for LineColumn

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 advance_cols(self, _: 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, _: usize) -> Self

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

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 Copy for LineColumn

impl Eq for LineColumn

impl StructuralPartialEq for LineColumn