Struct rhai::Position

pub struct Position { /* fields omitted */ }

A location (line number + character position) in the input script.

Limitations

In order to keep footprint small, both line number and character position have 16-bit resolution, meaning they go up to a maximum of 65,535 lines and 65,535 characters per line.

Advancing beyond the maximum line length or maximum number of lines is not an error but has no effect.

Implementations

impl Position

pub const NONE: Self

A Position representing no position.

pub const START: Self

A Position representing the first position.

pub fn new(line: u16, position: u16) -> Self

Create a new Position.

line must not be zero. If Position is zero, then it is at the beginning of a line.

Panics

Panics if line is zero.

pub fn line(self) -> Option<usize>

Get the line number (1-based), or None if there is no position.

pub fn position(self) -> Option<usize>

Get the character position (1-based), or None if at beginning of a line.

pub fn is_beginning_of_line(self) -> bool

Is this Position at the beginning of a line?

pub fn is_none(self) -> bool

Is there no Position?

Trait Implementations

impl Clone for Position

pub fn clone(&self) -> Position

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Position

impl Debug for Position

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

Formats the value using the given formatter.

impl Default for Position

pub fn default() -> Self

Returns the "default value" for a type.

impl Display for Position

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

Formats the value using the given formatter.

impl Eq for Position

impl Hash for Position

pub fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

pub fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl Ord for Position

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

Restrict a value to a certain interval.

impl PartialEq<Position> for Position

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

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

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

This method tests for !=.

impl PartialOrd<Position> for Position

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

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

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

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

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

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

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

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

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