Struct LuaUserdata 

pub struct LuaUserdata { /* private fields */ }

Userdata - arbitrary Rust data with optional metatable.

Uses Box<dyn UserDataTrait> for trait-based dispatch of field access, method calls, and metamethods. Falls back to metatable for Lua-level customization.

Implementations

impl LuaUserdata

pub fn new<T: UserDataTrait>(data: T) -> Self

Create a new userdata wrapping a value that implements UserDataTrait.

pub fn from_boxed(data: Box<dyn UserDataTrait>) -> Self

Create a userdata from an already-boxed trait object.

Used by the VM to convert UdValue::UserdataOwned results from arithmetic trait methods into GC-managed userdata.

pub unsafe fn from_ref<T: UserDataTrait>(reference: &mut T) -> Self

Create a borrowed userdata from a mutable reference.

The resulting userdata forwards all field/method/metamethod access through a raw pointer — zero overhead, no ownership transfer.

Safety

The referenced object must outlive all Lua accesses to this userdata. Accessing the userdata after the Rust object is dropped is undefined behavior.

pub unsafe fn from_raw_ptr<T: UserDataTrait>(ptr: *mut T) -> Self

Create a borrowed userdata from a raw pointer.

Safety

The pointer must be valid and properly aligned for the entire duration that Lua can access this userdata.

pub fn with_metatable<T: UserDataTrait>(data: T, metatable: TablePtr) -> Self

Create a new userdata with an initial metatable.

pub fn get_trait(&self) -> &dyn UserDataTrait

Get the trait object for direct field/method/metamethod dispatch.

pub fn get_trait_mut(&mut self) -> &mut dyn UserDataTrait

Get the mutable trait object.

pub fn type_name(&self) -> &'static str

Get the type name from the trait.

pub fn downcast_ref<T: 'static>(&self) -> Option<&T>

Downcast to a concrete type (immutable). Equivalent to old get_data().downcast_ref::<T>().

pub fn downcast_mut<T: 'static>(&mut self) -> Option<&mut T>

Downcast to a concrete type (mutable). Equivalent to old get_data_mut().downcast_mut::<T>().

pub fn get_data(&self) -> &dyn Any

Get raw &dyn Any reference (backward compatibility).

pub fn get_data_mut(&mut self) -> &mut dyn Any

Get raw &mut dyn Any reference (backward compatibility).

pub fn get_metatable(&self) -> Option<LuaValue>

Trait Implementations

impl Debug for LuaUserdata

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

Formats the value using the given formatter.

impl From<LuaUserdata> for AsyncReturnValue

fn from(ud: LuaUserdata) -> Self

Converts to this type from the input type.