Enum Statement

pub enum Statement {
    ERROR,
    LocalFunction(Pointer<LocalFunction>),
    LocalAssignment(Pointer<LocalAssignment>),
    TypeDefinition(Pointer<TypeDefinition>),
    IfStatement(Pointer<IfStatement>),
    DoBlock(Pointer<DoBlock>),
    GenericFor(Pointer<GenericFor>),
    NumericalFor(Pointer<NumericalFor>),
    RepeatBlock(Pointer<RepeatBlock>),
    WhileLoop(Pointer<WhileLoop>),
    SetExpression(Pointer<SetExpression>),
    CompoundSetExpression(Pointer<CompoundSetExpression>),
    FunctionCall(Pointer<FunctionCall>),
    GlobalFunction(Pointer<GlobalFunction>),
    TypeFunction(Pointer<TypeFunction>),
    EndOfFile(Pointer<EndOfFile>),
}

All possible statements in a CST, excluding ending ones.

Variants

ERROR

This statement had an error and couldn’t parse anything.

LocalFunction(Pointer<LocalFunction>)

A local function.

local function foo(bar: string): Qux
end

LocalAssignment(Pointer<LocalAssignment>)

A variable declaration.

local foo = bar
local bar = function()
end
local qux = {}

TypeDefinition(Pointer<TypeDefinition>)

A type definition.

type Foo = Bar<string, number>
export type Bar<P, R> = (param: P) -> R
type qux = {}

IfStatement(Pointer<IfStatement>)

An if statement.

if a then
    print("It's a")
elseif b then
    print("It's b")
else
    print("It's neither a or b :(")
end

DoBlock(Pointer<DoBlock>)

A do block.

do
    print("Hello, World!")
end

Note

This struct isn’t used for while or for loops, they have their own tokens, and have do blocks as part of their token.

GenericFor(Pointer<GenericFor>)

A generic for loop.

for i, v in ipairs(t) do
    print(`{i}: {v}`)
end

NumericalFor(Pointer<NumericalFor>)

A numerical for loop.

for i = 1, 100, 2 do
    print(i)
end

RepeatBlock(Pointer<RepeatBlock>)

A repeat block.

local i = 0
repeat
    print(i)
    i += 1
until i == 10

WhileLoop(Pointer<WhileLoop>)

A while loop.

local i = 0
while i <= 10 do
    print(i)
    i += 1
end

SetExpression(Pointer<SetExpression>)

A set expression.

a = "test"
b, c = true, false, 1
d, e, f = foo()

CompoundSetExpression(Pointer<CompoundSetExpression>)

A compound set expression.

foo += 1
bar //= 2

FunctionCall(Pointer<FunctionCall>)

A function call.

local _ = foo(1, 2, 3)

GlobalFunction(Pointer<GlobalFunction>)

A global function.

function foo(bar: string): Qux
end
function foo:Qux(bar: string): Qux
end

TypeFunction(Pointer<TypeFunction>)

A type function

type function Foo(ty)
    return types.unionof(types.string, ty)
end

export type function Bar(ty)
    return types.unionof(types.number, ty)
end

type qux = Bar<Foo<boolean>> -- number | string | boolean

EndOfFile(Pointer<EndOfFile>)

The EndOfFile token. Read it’s documentation for it’s uses.

Trait Implementations

impl Clone for Statement

fn clone(&self) -> Statement

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Statement

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

Formats the value using the given formatter.

impl Default for Statement

fn default() -> Statement

Returns the “default value” for a type.

impl GetRange for Statement

fn get_range(&self) -> Result<Range, GetRangeError>

Get the range of the node.

impl Hash for Statement

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Statement

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized,

Restrict a value to a certain interval.

impl Parse for Statement

fn parse( token: Token, lexer: &mut Lexer, errors: &mut Vec<Error>, ) -> Option<Self>

Try parsing the current item, starting from the passed token.

impl PartialEq for Statement

fn eq(&self, other: &Statement) -> 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 PartialOrd for Statement

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Print for Statement

fn print_final_trivia(&self) -> String

Prints only the very final trivia. Used for the default implementation of Print::print, which just joins Print::print_without_final_trivia and this function.

fn print_without_final_trivia(&self) -> String

Prints the whole token including all surrounding trivia, excluding the very last trailing trivia.

fn print(&self) -> String

Prints the whole token including all surrounding trivia.

impl Eq for Statement

impl StructuralPartialEq for Statement