Struct brane_dsl::spec::TextPos

pub struct TextPos {
    pub line: usize,
    pub col: usize,
}

Defines a position in the input text.

Fields

line: usize

The y-coordinate of the position (one-indexed)

col: usize

The x-coordinate of the position (one-indexed)

Implementations

impl TextPos

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

Constructor for the TextPos.

Arguments

• line: The line number.
• col: The column number.

Returns

A new TextPos instance with the given line and column number.

pub const fn none() -> Self

Constructor for the TextPos that initializes it to ‘none’.

Returns

A new TextPos instance that represents ‘no position’.

pub fn end_of<T: AsBytes, X>(span: &LocatedSpan<T, X>) -> Self

Constructor for the TextPos that initializes it to the end of the given Span.

Concretely, it adds the length of the span to the Span’s start location, modulo any newlines (‘\n’) it finds.

Generic types

• T: The type stored in the LocatedSpan.
• X: Any extra information stored in the span.

Arguments

• span: The LocatedSpan that contains both the text and position that we will use to compute the end position.

Returns

A new TextPos instance that points to the end of the span (inclusive).

pub const fn is_some(&self) -> bool

Returns if this TextPos is a position (i.e., does not represent ‘no position’).

Returns

Whether or not this TextPos represents a useable position (true) or if it is ‘no position’ (false).

pub const fn is_none(&self) -> bool

Returns if this TextPos is not a position (i.e., represents ‘no position’).

Returns

Whether or not this TextPos represents a useable position (false) or if it is ‘no position’ (true).

Trait Implementations

impl Clone for TextPos

fn clone(&self) -> TextPos

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TextPos

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

Formats the value using the given formatter.

impl Default for TextPos

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for TextPos

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for TextPos

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

Formats the value using the given formatter.

impl<T: AsBytes, X> From<&LocatedSpan<T, X>> for TextPos

fn from(value: &LocatedSpan<T, X>) -> Self

Converts to this type from the input type.

impl<T: AsBytes, X> From<LocatedSpan<T, X>> for TextPos

fn from(value: LocatedSpan<T, X>) -> Self

Converts to this type from the input type.

impl Serialize for TextPos

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.