[−][src]Struct source_span::Position
Position in a source file.
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
.
Methods
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(&self, c: char) -> Self
[src]
Move to the position following the given char
.
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.
This function assumes there is a tab-stop every 8 columns.
Note that there is no standard on the size of a tabulation, however a
length of 8 columns seems typical.
As of today, there is no way to use another tab length.
I understand that this lacks of flexibility may become an issue in the near future, and I will try to add this possibility. In the meantime, you are very welcome to contribute if you need this feature right away.
Full-width characters
As for now, double-width characters of full-width characters are not supported. They will move the cursor by only one column as any other regular-width character. You are welcome to contribute to handle them.
Trait Implementations
impl Clone for Position
[src]
impl Copy for Position
[src]
impl Debug for Position
[src]
impl Default for Position
[src]
impl Display for Position
[src]
impl Eq for Position
[src]
impl From<Position> for Span
[src]
impl Hash for Position
[src]
fn hash<__H: Hasher>(&self, state: &mut __H)
[src]
fn hash_slice<H>(data: &[Self], state: &mut H) where
H: Hasher,
1.3.0[src]
H: Hasher,
impl Ord for Position
[src]
fn cmp(&self, other: &Position) -> Ordering
[src]
#[must_use]
fn max(self, other: Self) -> Self
1.21.0[src]
#[must_use]
fn min(self, other: Self) -> Self
1.21.0[src]
#[must_use]
fn clamp(self, min: Self, max: Self) -> Self
[src]
impl PartialEq<Position> for Position
[src]
impl PartialOrd<Position> for Position
[src]
fn partial_cmp(&self, other: &Position) -> Option<Ordering>
[src]
fn lt(&self, other: &Position) -> bool
[src]
fn le(&self, other: &Position) -> bool
[src]
fn gt(&self, other: &Position) -> bool
[src]
fn ge(&self, other: &Position) -> bool
[src]
impl StructuralEq for Position
[src]
impl StructuralPartialEq for Position
[src]
Auto Trait Implementations
impl RefUnwindSafe for Position
impl Send for Position
impl Sync for Position
impl Unpin for Position
impl UnwindSafe for Position
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
fn to_owned(&self) -> T
[src]
fn clone_into(&self, target: &mut T)
[src]
impl<T> ToString for T where
T: Display + ?Sized,
[src]
T: Display + ?Sized,
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,