Enum mlua_extras::typed::Type

pub enum Type {
    Single(Cow<'static, str>),
    Value(Box<Type>),
    Alias(Box<Type>),
    Enum(Cow<'static, str>, Vec<Type>),
    Class(Box<Class>),
    Tuple(Vec<Type>),
    Struct(BTreeMap<&'static str, Type>),
    Variadic(Box<Type>),
    Union(Vec<Type>),
    Array(Box<Type>),
    Map(Box<Type>, Box<Type>),
    Function {
        params: Vec<Param>,
        returns: Vec<Type>,
    },
}

Representation of a lua type for a rust type

Variants

Single(Cow<'static, str>)

string nil boolean “literal” 3 … etc

Value(Box<Type>)

Alias(Box<Type>)

— @alias {name}

Enum(Cow<'static, str>, Vec<Type>)

Same as alias but with a set name predefined — @alias {name}

Class(Box<Class>)

— @class {name} — @field …

Tuple(Vec<Type>)

{ [1]: , [2]: , …etc }

Struct(BTreeMap<&'static str, Type>)

Variadic(Box<Type>)

Union(Vec<Type>)

Array(Box<Type>)

Map(Box<Type>, Box<Type>)

Function

Fields

params: Vec<Param>

returns: Vec<Type>

Implementations

impl Type

pub fn literal_string<T: Display>(value: T) -> Self

Create a lua type literal for a string. i.e. "string"

pub fn literal<T: Display>(value: T) -> Self

Create a lua type literal from a rust value. i.e. 3, true, etc…

pub fn single(value: impl Into<Cow<'static, str>>) -> Self

Create a type that has a single value. i.e. string, number, etc…

pub fn enum( name: impl Into<Cow<'static, str>>, types: impl IntoIterator<Item = Type>, ) -> Self

Create an enum type. This is equal to an alias

pub fn alias(ty: Type) -> Self

Create a type that is an alias. i.e. --- @alias {name} string

pub fn variadic(ty: Type) -> Self

Create a type that is variadic. i.e. ...type

pub fn array(ty: Type) -> Self

Create a type that is an array. i.e. { [integer]: type }

pub fn union(types: impl IntoIterator<Item = Type>) -> Self

Create a type that is a union. i.e. string | integer | nil

pub fn tuple(types: impl IntoIterator<Item = Type>) -> Self

create a type that is a tuple. i.e. { [1]: type, [2]: type }

pub fn class<T: TypedUserData>() -> Self

create a type that is a class. i.e. --- @class {name}

pub fn function<Params: TypedMultiValue, Response: TypedMultiValue>() -> Self

create a type that is a function. i.e. fun(self): number

Trait Implementations

impl AsRef<str> for Type

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.

impl BitOr for Type

Allows to union types

Example

use mlua_extras::typed::Type;

Type::single("string") | Type::single("nil")

type Output = Type

The resulting type after applying the | operator.

fn bitor(self, rhs: Self) -> Self::Output

Performs the | operation.

impl Clone for Type

fn clone(&self) -> Type

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Type

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

Formats the value using the given formatter.

impl From<&'static str> for Type

fn from(value: &'static str) -> Self

Converts to this type from the input type.

impl From<Cow<'static, str>> for Type

fn from(value: Cow<'static, str>) -> Self

Converts to this type from the input type.

impl From<String> for Type

fn from(value: String) -> Self

Converts to this type from the input type.

impl From<Type> for Param

fn from(value: Type) -> Self

Converts to this type from the input type.

impl Ord for Type

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

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

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

impl StructuralPartialEq for Type