Struct source_span::Position [−][src]
Position in a source file (line and column).
This holds the line and column position of a character in a source file.
Some operations are available to move position in a file. In partular, the
next
method computes the next cursor position after
reading a given char
.
Display
The struct implements two different format traits:
fmt::Display
will format the position asline {line} column {column}
fmt::Debug
will format the position as{line}:{column}
.
Both of them will display lines and columns starting at 1
even though the
internal representation starts at 0
.
Fields
line: usize
Line number, starting at 0
.
column: usize
Column number, starting at 0
.
Implementations
impl Position
[src]
impl Position
[src]#[must_use]pub const fn new(line: usize, column: usize) -> Self
[src]
Create a new position given a line and column.
Indexes starts at 0
.
#[must_use]pub const fn end() -> Self
[src]
Return the maximum position.
Example
use source_span::Position; assert_eq!( Position::end(), Position::new(usize::max_value(), usize::max_value()) );
#[must_use]pub const fn next_column(&self) -> Self
[src]
Move to the next column.
#[must_use]pub const fn reset_column(&self) -> Self
[src]
Move to the begining of the line.
#[must_use]pub const fn next_line(&self) -> Self
[src]
Move to the next line, and reset the column position.
#[must_use]pub fn next<M: Metrics>(&self, c: char, metrics: &M) -> Self
[src]
Move to the position following the given char
using the given Metrics
.
Control characters
This crate is intended to help with incremental lexing/parsing. Therefore, any control character moving the cursor backward will be ignored: it will be treated as a 0-width character with no semantics.
New lines
The \n
character is interpreted with the Unix semantics, as the new
line (NL) character. It will reset the column position to 0
and
move to the next line.
Tabulations
The \t
will move the cursor to the next horizontal tab-top.
The length of a tab-stop (in columns) is given by the metrics
parameter.
Full-width characters
Note that, as for now, double-width characters of full-width characters are not
supported by the DefaultMetrics
.
They will move the cursor by only one column as any other
regular-width character. You are welcome to contribute to handle
them.
pub fn shift<M: Metrics>(&mut self, c: char, metrics: &M)
[src]
Trait Implementations
impl PartialOrd<Position> for Position
[src]
impl PartialOrd<Position> for Position
[src]impl StructuralEq for Position
[src]
impl StructuralEq for Position
[src]impl StructuralPartialEq for Position
[src]
impl StructuralPartialEq for Position
[src]Auto Trait Implementations
impl RefUnwindSafe for Position
impl RefUnwindSafe for Position
impl UnwindSafe for Position
impl UnwindSafe for Position