Enum 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/manual.rs (line 56)

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

examples/manual_documentation.rs (line 68)

    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 duplicate 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 FromLua for Type

fn from_lua(lua_value: Value, lua: &Lua) -> Result<Self>

Performs the conversion.

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.

impl TealData for Type

fn add_fields<F: TealDataFields<Self>>(fields: &mut F)

same as UserData::add_fields. Refer to its documentation on how to use it.

fn add_methods<T: TealDataMethods<Self>>(methods: &mut T)

same as UserData::add_methods. Refer to its documentation on how to use it.

impl ToTypename for Type

fn to_typename() -> Type

generates the type representation

fn to_old_type_parts() -> Cow<'static, [NamePart]>

👎Deprecated

Used to get the old representation. Should basically never be used or implemented manually

fn to_function_param() -> Vec<FunctionParam>

generates the type representation when used as a parameter By default will assume no name was given

impl TypeBody for Type

fn get_type_body() -> TypeGenerator

Fills in the TypeGenerator so a .d.tl file can be constructed.

impl UserData for Type

fn add_fields<F: UserDataFields<Self>>(fields: &mut F)

Adds custom fields specific to this userdata.

fn add_methods<M: UserDataMethods<Self>>(methods: &mut M)

Adds custom methods and operators specific to this userdata.

fn register(registry: &mut UserDataRegistry<Self>)

Registers this type for use in Lua.