Enum tealr::Type

pub enum Type {
    Function(FunctionRepresentation),
    Single(SingleType),
    Map(MapRepresentation),
    Or(Vec<Type>),
    Array(Box<Type>),
    Tuple(Vec<Type>),
}

A type

Variants

Function(FunctionRepresentation)

The type is a function

Single(SingleType)

The type is a simple, singular type

Map(MapRepresentation)

The type is a Map<K,V> (Think HashMap<K,V> and similar)

Or(Vec<Type>)

The type is a union (A | B)

Array(Box<Type>)

The type is an array

Tuple(Vec<Type>)

This one doesn’t really exist in lua/teal but will expand in (A,B,C) Sometimes useful for the return type or parameters but should be used very carefully As it can easily break things

Implementations

impl Type

pub fn new_single(name: impl AsRef<str>, kind: KindOfType) -> Self

Creates a new singular type

Examples found in repository

examples/mlua/manual.rs (line 56)

    fn to_typename() -> tealr::Type {
        tealr::Type::new_single("Example", tealr::KindOfType::External)
    }

examples/mlua/manual_documentation.rs (line 68)

    fn to_typename() -> tealr::Type {
        tealr::Type::new_single("Example", tealr::KindOfType::External)
    }

examples/rlua/manual.rs (line 37)

    fn to_typename() -> tealr::Type {
        tealr::Type::new_single("Example", tealr::KindOfType::External)
    }

examples/rlua/manual_documentation.rs (line 36)

    fn to_typename() -> tealr::Type {
        tealr::Type::new_single("Example", tealr::KindOfType::External)
    }

Trait Implementations

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<'de> Deserialize<'de> for Type

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<Box<Type>> for Type

fn from(value: Box<Type>) -> Self

Converts to this type from the input type.

impl Serialize for Type

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

where __S: Serializer,

Serialize this value into the given Serde serializer.