Struct regex_syntax::ast::Position

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

A single position in a regular expression.

A position encodes one half of a span, and include the byte offset, line number and column number.

Fields

offset: usize

The absolute offset of this position, starting at 0 from the beginning of the regular expression pattern string.

line: usize

The line number, starting at 1.

column: usize

The approximate column number, starting at 1.

Methods

impl Position

pub fn new(offset: usize, line: usize, column: usize) -> Position

Create a new position with the given information.

offset is the absolute offset of the position, starting at 0 from the beginning of the regular expression pattern string.

line is the line number, starting at 1.

column is the approximate column number, starting at 1.

Trait Implementations

impl Clone for Position

fn clone(&self) -> Position

Returns a copy 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 Ord for Position

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

This method returns an [Ordering] between self and other.

#[must_use] fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use] fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use] fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl PartialEq<Position> for Position

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl PartialOrd<Position> for Position

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

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

#[must_use] fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use] fn le(&self, other: &Rhs) -> bool

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

#[must_use] fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use] fn ge(&self, other: &Rhs) -> bool

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

impl StructuralEq for Position

impl StructuralPartialEq for Position