Struct LineNumber

pub struct LineNumber(pub u32);

A distinct number type for line numbers, to prevent confusion with other numerical data.

Zero-indexed internally.

We use a 32-bit integer, so a file cannot have more than 4 billion lines. This keeps the size of the struct small. It’s common to have a lot of LineNumbers when analysing large files, so the struct size is more important than handling crazy big files.

Tuple Fields

0: u32

Implementations

impl LineNumber

pub fn display(self) -> String

Examples found in repository

examples/simple.rs (line 15)

fn main() {
    let s = "foo\nbar\nbaz\n";
    let s_lines: Vec<_> = s.lines().collect();

    let line_positions = LinePositions::from(s);

    let offset = 5;
    let (line_num, column) = line_positions.from_offset(offset);

    println!(
        "Offset {} is on line {} (column {}), and the text of that line is {:?}.",
        offset,
        line_num.display(),
        column,
        s_lines[line_num.as_usize()]
    );
}

pub fn as_usize(self) -> usize

Examples found in repository

examples/simple.rs (line 17)

fn main() {
    let s = "foo\nbar\nbaz\n";
    let s_lines: Vec<_> = s.lines().collect();

    let line_positions = LinePositions::from(s);

    let offset = 5;
    let (line_num, column) = line_positions.from_offset(offset);

    println!(
        "Offset {} is on line {} (column {}), and the text of that line is {:?}.",
        offset,
        line_num.display(),
        column,
        s_lines[line_num.as_usize()]
    );
}

Trait Implementations

impl Clone for LineNumber

fn clone(&self) -> LineNumber

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for LineNumber

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

Formats the value using the given formatter.

impl From<u32> for LineNumber

fn from(number: u32) -> Self

Converts to this type from the input type.

impl Hash for LineNumber

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 LineNumber

fn cmp(&self, other: &LineNumber) -> 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 LineNumber

fn eq(&self, other: &LineNumber) -> bool

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

const 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 LineNumber

fn partial_cmp(&self, other: &LineNumber) -> 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 Copy for LineNumber

impl Eq for LineNumber

impl StructuralPartialEq for LineNumber