Struct rhai::plugin::Position

pub struct Position { /* private fields */ }

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 fn new_const(line: u16, position: u16) -> Option<Self>

👎Deprecated since 1.6.0:

use new instead

Create a new Position.

If line is zero, then None is returned.

If position is zero, then it is at the beginning of a line.

Deprecated

This function is deprecated. Use new (which panics when line is zero) instead.

This method will be removed in the next major version.

impl Position

pub const NONE: Self = _

A Position representing no position.

pub const START: Self = _

A Position representing the first position.

pub const 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 const fn line(self) -> Option<usize>

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

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

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

pub const fn is_beginning_of_line(self) -> bool

Is this Position at the beginning of a line?

pub const fn is_none(self) -> bool

Is there no Position?

pub const fn or_else(self, pos: Self) -> Self

Returns an fallback Position if it is NONE?

Trait Implementations

impl Add<Position> for Position

type Output = Position

The resulting type after applying the + operator.

fn add(self, rhs: Self) -> Self::Output

Performs the + operation.

impl AddAssign<Position> for Position

fn add_assign(&mut self, rhs: Self)

Performs the += operation.

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

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

Formats the value using the given formatter.

impl Default for Position

fn default() -> Self

Returns the “default value” for a type.

impl Display for Position

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

Formats the value using the given formatter.

impl Hash for Position

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,

Feeds a slice of this type into the given Hasher.

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

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere
    Self: PartialOrd<Self>,

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: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

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.

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

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

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

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

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

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

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

impl Eq for Position

impl StructuralEq for Position

impl StructuralPartialEq for Position