Module tealr::rlu

traits and types specific to rlua

Re-exports

• pub use rlua;

Modules

• generics
  this module holds some pre made types that can be used to create generics.

Macros

• create_generic
  This macro creates a new type that acts as similar as possible to rlua::Value however, it acts as a generic type instead of being translated as any.
• create_named_parameters
  Creates a type that allows you to give names to the positional parameters. The names only show up in the documentation and definition files. Making them great to add just a bit more of documentation in the function signature itself
• create_union
  Creates a new type that is a union of the types you gave.

Structs

• TypedFunction
  A typed wrapper around rlua::Function
• UserDataWrapper
  Used to turn UserDataMethods into TealDataMethods.

Traits

• ExportInstances
  implement this to easily document what global instances are exposed to lua
• FromLuaExact
  similar to rlua::FromLua. However, however going through this trait you promise that the conversion to a rust value prefers failing over converting/casting
• InstanceCollector
  collets every instance that needs to be exposed to lua
• TealData
  This is the teal version of UserData.
• TealDataMethods
  The teal version of UserDataMethods

Functions

• get_type_name
  Gets the type of a function that is useful for the FromLuaConversion/ToLuaConversion error.
• set_global_env
  used to export instances to lua

Derive Macros

• FromToLua
  Implements the needed traits to make this trait convertible to and from lua values. It does this differently for structs and enums but will implement the TypeBody trait in both cases.
• TealDerive
  Implement both rlua::UserData and [TypeName](tealr::TypeName].
• UserData
  Implements rlua::UserData and tealr::TypeBody