Struct sub_script::engine::Position

source · [−]

pub struct Position { /* private fields */ }

Expand description

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

source

impl Position

source

pub const fn new_const(line: u16, position: u16) -> Option<Position>

👎 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.

source

impl Position

source

pub const NONE: Position = Self{line: 0, pos: 0,}

A Position representing no position.

source

pub const START: Position = Self{line: 1, pos: 0,}

A Position representing the first position.

source

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

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.

source

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

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

source

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

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

source

pub const fn is_beginning_of_line(self) -> bool

Is this Position at the beginning of a line?

source

pub const fn is_none(self) -> bool

Is there no Position?

source

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

Returns an fallback Position if it is NONE?

Trait Implementations

source

impl Add<Position> for Position

type Output = Position

The resulting type after applying the + operator.

source

fn add(self, rhs: Position) -> <Position as Add<Position>>::Output

Performs the + operation. Read more

source

impl AddAssign<Position> for Position

source

fn add_assign(&mut self, rhs: Position)

Performs the += operation. Read more

source

impl Clone for Position

source

fn clone(&self) -> Position

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

source

impl Debug for Position

source

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

Formats the value using the given formatter. Read more

source

impl Default for Position

source

fn default() -> Position

Returns the “default value” for a type. Read more

source

impl Display for Position

source

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

Formats the value using the given formatter. Read more

source

impl Hash for Position

source

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

Feeds this value into the given Hasher. Read more

1.3.0 · source

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

Feeds a slice of this type into the given Hasher. Read more

source

impl Ord for Position

source

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

This method returns an Ordering between self and other. Read more

1.21.0 · source

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

Compares and returns the maximum of two values. Read more

1.21.0 · source

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

Compares and returns the minimum of two values. Read more

1.50.0 · source

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

Restrict a value to a certain interval. Read more

source

impl PartialEq<Position> for Position

source

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

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

source

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

This method tests for !=.

source

impl PartialOrd<Position> for Position

source

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

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

1.0.0 · source

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

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

1.0.0 · source

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

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

1.0.0 · source

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

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

1.0.0 · source

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

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

source

impl StructuralPartialEq for Position

Auto Trait Implementations

impl RefUnwindSafe for Position

impl Send for Position

impl Sync for Position

impl Unpin for Position

impl UnwindSafe for Position

Blanket Implementations

source

impl<T> Any for T where
T: 'static + ?Sized,

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> CallHasher for T where
T: Hash + ?Sized,

default fn get_hash<H, B>(value: &H, build_hasher: &B) -> u64 where
H: Hash + ?Sized,
B: BuildHasher,

impl<T> CallHasher for T where
T: Hash,

fn get_hash<H>(&self, hasher: H) -> u64 where
H: Hasher,

source

impl<T> CheckedConversion for T

source

fn checked_from<T>(t: T) -> Option<Self> where
Self: TryFrom<T>,

Convert from a value of T into an equivalent instance of Option<Self>. Read more

source

fn checked_into<T>(self) -> Option<T> where
Self: TryInto<T>,

Consume self to return Some equivalent value of Option<T>. Read more

source

impl<T> Clear for T where
T: Default + Eq + PartialEq<T>,

source

fn is_clear(&self) -> bool

True iff no bits are set.

source

fn clear() -> T

Return the value of Self that is clear.

source

impl<T> DynClone for T where
T: Clone,

source

fn __clone_box(&self, Private) -> *mut ()

source

impl<Q, K> Equivalent<K> for Q where
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,

source

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T> Instrument for T

source

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

source

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

source

impl<T, U> Into for T where
U: From<T>,

const: unstable · source

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source

impl<T> IsType<T> for T

source

fn from_ref(t: &T) -> &T

Cast reference.

source

fn into_ref(&self) -> &T

Cast reference.

source

fn from_mut(t: &mut T) -> &mut T

Cast mutable reference.

source

fn into_mut(&mut self) -> &mut T

Cast mutable reference.

source

impl<T, Outer> IsWrappedBy<Outer> for T where
Outer: AsRef<T> + AsMut<T> + From<T>,
T: From<Outer>,

source

fn from_ref(outer: &Outer) -> &T

Get a reference to the inner from the outer.

source

fn from_mut(outer: &mut Outer) -> &mut T

Get a mutable reference to the inner from the outer.

source

impl<T> Same<T> for T

type Output = T

Should always be Self

impl<T> SaturatedConversion for T

fn saturated_from<T>(t: T) -> Self where
Self: UniqueSaturatedFrom<T>,

Convert from a value of T into an equivalent instance of Self. Read more

fn saturated_into<T>(self) -> T where
Self: UniqueSaturatedInto<T>,

Consume self to return an equivalent value of T. Read more

source

impl<T> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

source

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

source

fn clone_into(&self, target: &mut T)

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

Uses borrowed data to replace owned data, usually by cloning. Read more

source

impl<T> ToString for T where
T: Display + ?Sized,

source

default fn to_string(&self) -> String

Converts the given value to a String. Read more

source

impl<T, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

source

impl<S, T> UncheckedInto<T> for S where
T: UncheckedFrom<S>,

source

fn unchecked_into(self) -> T

The counterpart to unchecked_from.

impl<T, S> UniqueSaturatedInto<T> for S where
T: Bounded,
S: TryInto<T>,

fn unique_saturated_into(self) -> T

Consume self to return an equivalent value of T.

impl<V, T> VZip<V> for T where
V: MultiLane<T>,

fn vzip(self) -> V

source

impl<T> WithSubscriber for T

source

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

source

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more

impl<T> Error for T where
T: 'static + Debug + Display + Send + Sync,

impl<T> MaybeDebug for T where
T: Debug,

source

impl<T> MaybeDisplay for T where
T: Display,

source

impl<T> MaybeHash for T where
T: Hash,

impl<T> MaybeRefUnwindSafe for T where
T: RefUnwindSafe,

source

Struct sub_script::engine::Position

Implementations

impl Position

pub const fn new_const(line: u16, position: u16) -> Option<Position>

impl Position

pub const NONE: Position = Self{line: 0, pos: 0,}

pub const START: Position = Self{line: 1, pos: 0,}

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

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

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

pub const fn is_beginning_of_line(self) -> bool

pub const fn is_none(self) -> bool

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

Trait Implementations

impl Add<Position> for Position

type Output = Position

fn add(self, rhs: Position) -> <Position as Add<Position>>::Output

impl AddAssign<Position> for Position

fn add_assign(&mut self, rhs: Position)

impl Clone for Position

fn clone(&self) -> Position

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

impl Debug for Position

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

impl Default for Position

fn default() -> Position

impl Display for Position

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

impl Hash for Position

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

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

impl Ord for Position

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

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

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

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

impl PartialEq<Position> for Position

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

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

impl PartialOrd<Position> for Position

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

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

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

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

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

impl Copy for Position

impl Eq for Position

impl StructuralEq for Position

impl StructuralPartialEq for Position

Auto Trait Implementations

impl RefUnwindSafe for Position

impl Send for Position

impl Sync for Position

impl Unpin for Position

impl UnwindSafe for Position

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> CallHasher for T where T: Hash + ?Sized,

default fn get_hash<H, B>(value: &H, build_hasher: &B) -> u64 where H: Hash + ?Sized, B: BuildHasher,

impl<T> CallHasher for T where T: Hash,

fn get_hash<H>(&self, hasher: H) -> u64 where H: Hasher,

impl<T> CheckedConversion for T

fn checked_from<T>(t: T) -> Option<Self> where Self: TryFrom<T>,

fn checked_into<T>(self) -> Option<T> where Self: TryInto<T>,

impl<T> Clear for T where T: Default + Eq + PartialEq<T>,

fn is_clear(&self) -> bool

fn clear() -> T

impl<T> DynClone for T where T: Clone,

fn __clone_box(&self, Private) -> *mut ()

impl<Q, K> Equivalent<K> for Q where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

impl<T> From<T> for T

fn from(t: T) -> T

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

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

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

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<T> CallHasher for T where
T: Hash + ?Sized,

default fn get_hash<H, B>(value: &H, build_hasher: &B) -> u64 where
H: Hash + ?Sized,
B: BuildHasher,

impl<T> CallHasher for T where
T: Hash,

fn get_hash<H>(&self, hasher: H) -> u64 where
H: Hasher,

fn checked_from<T>(t: T) -> Option<Self> where
Self: TryFrom<T>,

fn checked_into<T>(self) -> Option<T> where
Self: TryInto<T>,

impl<T> Clear for T where
T: Default + Eq + PartialEq<T>,

impl<T> DynClone for T where
T: Clone,

impl<Q, K> Equivalent<K> for Q where
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,

impl<T, U> Into<U> for T where
U: From<T>,

impl<T, Outer> IsWrappedBy<Outer> for T where
Outer: AsRef<T> + AsMut<T> + From<T>,
T: From<Outer>,

fn saturated_from<T>(t: T) -> Self where
Self: UniqueSaturatedFrom<T>,

fn saturated_into<T>(self) -> T where
Self: UniqueSaturatedInto<T>,

impl<T> ToOwned for T where
T: Clone,

impl<T> ToString for T where
T: Display + ?Sized,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

impl<S, T> UncheckedInto<T> for S where
T: UncheckedFrom<S>,

impl<T, S> UniqueSaturatedInto<T> for S where
T: Bounded,
S: TryInto<T>,

impl<V, T> VZip<V> for T where
V: MultiLane<T>,

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,

impl<T> Error for T where
T: 'static + Debug + Display + Send + Sync,

impl<T> MaybeDebug for T where
T: Debug,

impl<T> MaybeDebug for T where
T: Debug,

impl<T> MaybeDisplay for T where
T: Display,

impl<T> MaybeHash for T where
T: Hash,

impl<T> MaybeHash for T where
T: Hash,

impl<T> MaybeRefUnwindSafe for T where
T: RefUnwindSafe,

impl<T> Member for T where
T: 'static + Send + Sync + Debug + Eq + PartialEq<T> + Clone,