Struct Position 

pub struct Position {
    pub line: usize,
    pub column: usize,
}

A position in a document.

Lines and columns are 1-based. Columns count Unicode scalar values in the line’s content; they are not UTF-8 byte offsets, grapheme clusters, or display cells. A line containing "café" therefore ends at column 5.

The end-of-line column is immediately before the complete line terminator. Column 1 of the following line is immediately after it. Consequently CRLF is atomic: no valid Position can point between \r and \n.

EOF is represented by the final line’s end column when the document has no trailing terminator, or by column 1 of the next line when it does.

Fields

line: usize

Line number (1-based)

column: usize

Column number (1-based)

Implementations

impl Position

pub const fn line_start(line: usize) -> Self

Return column 1 of line.

pub fn line_end(line: usize, line_content: &str) -> Self

Return the position immediately after line_content and before its terminator, if any.

pub fn from_byte_offset_in_line( line: usize, line_content: &str, byte_offset: usize, ) -> Option<Self>

Convert a zero-based UTF-8 byte offset within one line to a scalar-based document position.

Returns None if byte_offset is outside line_content or is not a UTF-8 character boundary.

pub fn to_byte_offset(self, content: &str) -> Option<usize>

Resolve this position to a zero-based UTF-8 byte offset in content.

Invalid line or column numbers, including positions inside CRLF, return None.

pub fn from_byte_offset(content: &str, byte_offset: usize) -> Option<Self>

Convert a zero-based UTF-8 byte offset in content to a document position.

Offsets outside the document, in the middle of a UTF-8 scalar, or between the two bytes of a CRLF terminator return None.

Trait Implementations

impl Clone for Position

fn clone(&self) -> Position

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Position

impl Debug for Position

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

Formats the value using the given formatter.

impl Eq for Position

impl PartialEq for Position

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Position

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Position