Enum TypeValue

pub enum TypeValue {
    ERROR,
    String(Token),
    Boolean(Token),
    Nil(Token),
    Wrap(Bracketed<Pointer<TypeValue>>),
    Function {
        generics: Option<Pointer<GenericDeclaration>>,
        parameters: BracketedList<ParameterTypeName>,
        arrow: Token,
        return_type: Pointer<TypeValue>,
    },
    Basic {
        base: Token,
        generics: Option<Pointer<BracketedList<Pointer<TypeValue>>>>,
    },
    GenericPack {
        name: Token,
        ellipsis: Token,
    },
    Intersection {
        left: Pointer<TypeValue>,
        ampersand: Token,
        right: Pointer<TypeValue>,
    },
    Union {
        left: Pointer<TypeValue>,
        pipe: Token,
        right: Pointer<TypeValue>,
    },
    Module {
        module: Token,
        dot: Token,
        name: Token,
        generics: Option<Pointer<BracketedList<Pointer<TypeValue>>>>,
    },
    Optional {
        base: Pointer<TypeValue>,
        question_mark: Token,
    },
    Table(Table),
    Typeof {
        typeof_token: Token,
        inner: Bracketed<Pointer<Expression>>,
    },
    Tuple(BracketedList<Pointer<TypeValue>>),
    Variadic {
        ellipsis: Token,
        type_value: Pointer<TypeValue>,
    },
    VariadicPack {
        ellipsis: Token,
        name: Token,
    },
}

Possible values for a type.

Variants

ERROR

This TypeValue had a syntax error.

String(Token)

A singleton string.

type Foo = "Bar"

Boolean(Token)

A boolean value

type Foo = true
type Bar = false

Nil(Token)

nil

type Foo = nil

Wrap(Bracketed<Pointer<TypeValue>>)

A wrap of another type, the difference between this and a tuple is that this item always have one type and only one type in it, while a tuple can have any, even 0.

type Foo = (bar)

Function

A function type.

type Foo = (arg1: number) -> (boolean, string)`

Fields

generics: Option<Pointer<GenericDeclaration>>

Optional generics provided for the function.

type Foo = <P, R>(parameter: P) -> R

parameters: BracketedList<ParameterTypeName>

The parameters this function accepts.

arrow: Token

The -> character.

return_type: Pointer<TypeValue>

The return type of this function

Basic

A reference to a different type.

type Foo = Bar
type FooBar = Qux<string>

Fields

base: Token

The name of the type that has the generics.

generics: Option<Pointer<BracketedList<Pointer<TypeValue>>>>

Optional generics.

GenericPack

A generic pack.

<T...>

Fields

name: Token

The name.

ellipsis: Token

The ... characters.

Intersection

An intersection between two types.

type Foo = Bar & Qux

Fields

left: Pointer<TypeValue>

The type at the start.

ampersand: Token

The & character.

right: Pointer<TypeValue>

The type at the end.

Union

An union between two types.

type Foo = Bar & Qux

Fields

left: Pointer<TypeValue>

The type at the start.

pipe: Token

The | character.

right: Pointer<TypeValue>

The type at the end.

Module

An access to an exported type from a module.

Fields

module: Token

the name of the module.

dot: Token

The . between the module name and the type.

name: Token

The actual name of the type being accessed.

generics: Option<Pointer<BracketedList<Pointer<TypeValue>>>>

Optional generics.

Optional

An optional type.

type Foo = Bar?

This is just equivalent to:

type Foo = Bar | nil

Fields

base: Pointer<TypeValue>

The actual type.

question_mark: Token

The ? character.

Table(Table)

A table type.

type Foo = { string }
type Bar = { Qux: Foo }

Typeof

A typeof expression.

Fields

typeof_token: Token

The typeof word.

inner: Bracketed<Pointer<Expression>>

The expression passed to typeof.

Tuple(BracketedList<Pointer<TypeValue>>)

A tuple of types

type Foo = () -> (string, number)

The tuple here is the return type (string, number). In luau, tuples can’t be their own type, meaning, this is a syntax error:

type Foo = (string, number)

Variadic

A variadic type.

...Foo

The difference between this and a variadic pack is that this one can be with a type and not just a name:

...{ Foo: "Bar" }

And is that variadic types are used in function parameters and returns, while variadic packs are used for generics.

Fields

ellipsis: Token

The ... characters.

type_value: Pointer<TypeValue>

The actual type.

VariadicPack

A variadic pack.

...Foo

Note

See variadic type to learn the difference between them.

Fields

ellipsis: Token

The ... characters.

name: Token

The name

Trait Implementations

impl Clone for TypeValue

fn clone(&self) -> TypeValue

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TypeValue

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

Formats the value using the given formatter.

impl Default for TypeValue

fn default() -> TypeValue

Returns the “default value” for a type.

impl GetRange for TypeValue

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

Get the range of the node.

impl Hash for TypeValue

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 TypeValue

fn cmp(&self, other: &TypeValue) -> 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 TypeValue

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 TypeValue

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

fn partial_cmp(&self, other: &TypeValue) -> 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 TypeValue

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 TryParse for TypeValue

fn try_parse(lexer: &mut Lexer, errors: &mut Vec<Error>) -> Option<O>

Try parsing and reset the lexer’s state upon failure.

impl Eq for TypeValue

impl StructuralPartialEq for TypeValue