Struct Index

pub struct Index {
    pub target: Box<Expr>,
    pub index: Box<Expr>,
    pub span: Range<usize>,
    pub bracket_span: Range<usize>,
}

List indexing, such as list[0].

Fields

target: Box<Expr>

The expression being indexed.

index: Box<Expr>

The amount to index by.

span: Range<usize>

The region of the source code that this function call was parsed from.

bracket_span: Range<usize>

The span of the brackets that surround the index expression.

Implementations

impl Index

pub fn span(&self) -> Range<usize>

Returns the span of the index expression.

pub fn outer_span(&self) -> [Range<usize>; 2]

Returns a set of two spans, where the first is the span of the expression being indexed (with the opening bracket) and the second is the span of the closing bracket.

pub fn parse_or_lower( input: &mut Parser<'_>, recoverable_errors: &mut Vec<Error>, target: Primary, ) -> (Primary, bool)

Attempts to parse an Index, where the initial target has already been parsed.

Besides the returned Primary, the return value also includes a boolean that indicates if the expression was changed due to successfully parsing a Index. This function can return even if no Index, which occurs when we determine that we shouldn’t have taken the Index path. The boolean is used to let the caller know that this is was the case.

This is similar to what we had to do with Binary.

Trait Implementations

impl Clone for Index

fn clone(&self) -> Index

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Index

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

Formats the value using the given formatter.

impl Display for Index

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

Formats the value using the given formatter.

impl From<Index> for AssignTarget

fn from(index: Index) -> Self

Converts to this type from the input type.

impl Latex for Index

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

Format the value as LaTeX.

fn as_display(&self) -> LatexFormatter<'_, Self>

Wraps the value in a LatexFormatter, which implements Display.

impl<'source> Parse<'source> for Index

fn std_parse( input: &mut Parser<'source>, recoverable_errors: &mut Vec<Error>, ) -> Result<Self, Vec<Error>>

Parses a value from the given stream of tokens, advancing the stream past the consumed tokens if parsing is successful.

fn parse(input: &mut Parser<'source>) -> ParseResult<Self>

Parses a value from the given stream of tokens, advancing the stream past the consumed tokens if parsing is successful.

impl PartialEq for Index

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Eq for Index

impl StructuralPartialEq for Index