Struct Position 

pub struct Position { /* private fields */ }

Represents a position in source code.

Positions use zero-based line and column numbers, where line 0 is the first line and column 0 is the first character. Unlike tree-sitter’s internal positions, these are character-based rather than byte-based for easier human consumption.

Note

Computing the character column from byte positions is an O(n) operation, so avoid calling Position::column in performance-critical loops.

Example

let ast = Language::Tsx.ast_grep("let x = 42;\nlet y = 24;");
let root = ast.root();

let start_pos = root.start_pos();
assert_eq!(start_pos.line(), 0);

Implementations

impl Position

pub const fn new(line: usize, byte_column: usize, byte_offset: usize) -> Self

pub const fn line(&self) -> usize

pub fn column<D: Doc>(&self, node: &Node<'_, D>) -> usize

Returns the column in terms of characters. Note: node does not have to be a node of matching position.

pub const fn byte_point(&self) -> (usize, usize)

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

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

Formats the value using the given formatter.

impl Ord for Position

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

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

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

impl Eq for Position

impl StructuralPartialEq for Position