Struct LineCol 

pub struct LineCol {
    pub line: usize,
    pub line_start: usize,
}

Tracks a zero-based line index and the byte offset where that line starts.

Examples

use adze_linecol_core::LineCol;

let lc = LineCol::at_position(b"hello\nworld", 8);
assert_eq!(lc.line, 1);
assert_eq!(lc.column(8), 2);

Fields

line: usize

Zero-based line index.

line_start: usize

Byte offset for the start of the current line.

Implementations

impl LineCol

pub const fn new() -> Self

Create a new tracker at line 0, byte offset 0.

Examples

use adze_linecol_core::LineCol;

let lc = LineCol::new();
assert_eq!(lc.line, 0);
assert_eq!(lc.line_start, 0);

pub fn at_position(input: &[u8], position: usize) -> Self

Compute line metadata for a byte position in input.

If position is beyond input.len(), the end of input is used.

Examples

use adze_linecol_core::LineCol;

let lc = LineCol::at_position(b"hello\nworld\n", 6);
assert_eq!(lc.line, 1);
assert_eq!(lc.line_start, 6);
assert_eq!(lc.column(8), 2);

pub fn advance_line(&mut self, new_line_start: usize)

Advance to a new line, setting the new line’s starting byte offset.

Examples

use adze_linecol_core::LineCol;

let mut lc = LineCol::new();
lc.advance_line(5);
assert_eq!(lc.line, 1);
assert_eq!(lc.line_start, 5);

pub fn process_byte( &mut self, byte: u8, next_byte: Option<u8>, current_offset: usize, ) -> bool

Process one byte while scanning a stream and update line metadata.

Returns true if the byte advanced to a new line.

Note: for CRLF, this returns false for the CR byte and true for the LF byte.

Examples

use adze_linecol_core::LineCol;

let mut lc = LineCol::new();
assert!(!lc.process_byte(b'a', None, 0));
assert!(lc.process_byte(b'\n', None, 1));
assert_eq!(lc.line, 1);
assert_eq!(lc.line_start, 2);

pub fn column(&self, position: usize) -> usize

Compute a byte-based column for position.

Examples

use adze_linecol_core::LineCol;

let lc = LineCol::at_position(b"ab\ncd", 3);
assert_eq!(lc.column(3), 0); // start of line
assert_eq!(lc.column(4), 1); // one byte into line

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

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

Formats the value using the given formatter.

impl Default for LineCol

fn default() -> Self

Returns the “default value” for a type.

impl Display for LineCol

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

Formats the value using the given formatter.

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

impl Eq for LineCol

impl StructuralPartialEq for LineCol