Struct LineCol 

pub struct LineCol {
    pub line: u32,
    pub col: u32,
}

A resolved human coordinate: a 1-based line and a 1-based column.

The column counts Unicode scalar values (Rust chars), not bytes, not UTF-16 code units, and not grapheme clusters. A column therefore never lands inside a multi-byte UTF-8 sequence: the third char of a line is always column 3, whether the preceding characters were one byte each or four.

Both fields are 1-based because that is what editors, compilers, and language servers display — line 1, column 1 is the first character of the source.

LineCol is produced by LineIndex::line_col and consumed by LineIndex::offset; the two are inverses for every valid byte position.

Examples

use span_lang::LineCol;

let lc = LineCol::new(2, 5);
assert_eq!(lc.line, 2);
assert_eq!(lc.col, 5);
assert_eq!(lc.to_string(), "2:5");

Fields

line: u32

The 1-based line number.

col: u32

The 1-based column, counted in Unicode scalar values (chars).

Implementations

impl LineCol

pub const fn new(line: u32, col: u32) -> Self

Constructs a coordinate from a 1-based line and column.

This is a plain constructor; it does not validate that the coordinate exists in any particular source. Resolving a coordinate back to a byte offset is LineIndex::offset, which reports a position outside the source as None.

Examples

use span_lang::LineCol;

const ORIGIN: LineCol = LineCol::new(1, 1);
assert_eq!((ORIGIN.line, ORIGIN.col), (1, 1));

Trait Implementations

impl Clone for LineCol

fn clone(&self) -> LineCol

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for LineCol

impl Debug for LineCol

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

Formats the value using the given formatter.

impl Display for LineCol

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

Formats as line:col, the convention editors and compilers use.

impl Eq for LineCol

impl Hash for LineCol

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 Ord for LineCol

fn cmp(&self, other: &LineCol) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for LineCol

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

fn partial_cmp(&self, other: &LineCol) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralPartialEq for LineCol