Skip to main content

Module userdata

Module userdata 

Source
Expand description

Lua userdata handling.

This module provides types for creating and working with Lua userdata from Rust.

§Main Types

  • AnyUserData - A handle to a Lua userdata value of any Rust type.
  • UserData - Trait to implement for types that should be exposed to Lua as userdata.
  • UserDataFields - Trait for registering fields on userdata types.
  • UserDataMethods - Trait for registering methods on userdata types.
  • UserDataRegistry - Registry for userdata methods and fields.
  • UserDataMetatable - A handle to the metatable of a userdata type.
  • UserDataRef - A borrowed reference to a userdata value.
  • UserDataRefMut - A mutably borrowed reference to a userdata value.
  • MetaMethod - Metamethod names for customizing Lua operators.

Structs§

AnyUserData
Handle to an internal Lua userdata for any type that implements UserData.
UserDataMetatable
Handle to a AnyUserData metatable.
UserDataMetatablePairs
An iterator over the pairs of a AnyUserData metatable.
UserDataRef
A wrapper type for a userdata value that provides read access.
UserDataRefMut
A wrapper type for a userdata value that provides read and write access.
UserDataRegistry
Handle to registry for userdata methods and metamethods.

Enums§

MetaMethod
Kinds of metamethods that can be overridden.

Traits§

UserData
Trait for custom userdata types.
UserDataFields
Field registry for UserData implementors.
UserDataMethods
Method registry for UserData implementors.