Struct AnyUserData 

pub struct AnyUserData { /* private fields */ }

A handle to an arbitrary Lua userdata value.

Mirrors mlua::AnyUserData. Supports construction, use-from-Lua, and typed Rust-side borrowing (borrow / borrow_mut / take / is).

Implementations

impl AnyUserData

pub fn lua(&self) -> Lua

The owning Lua.

pub fn to_pointer(&self) -> *const c_void

A raw pointer identifying this userdata. Mirrors mlua::AnyUserData::to_pointer.

pub fn equals(&self, other: &AnyUserData) -> Result<bool>

Compare for equality honoring an __eq metamethod. Mirrors mlua::AnyUserData::equals.

pub fn is<T: 'static>(&self) -> bool

Whether the stored value is of concrete type T. Mirrors mlua::AnyUserData::is. Returns false after the value has been taken.

pub fn type_id(&self) -> Option<TypeId>

The TypeId of the stored value, if it is a luaur-rt userdata. Mirrors mlua::AnyUserData::type_id (here it returns the concrete TypeId whenever the userdata carries a luaur-rt wrapper header).

pub fn borrow<T: 'static>(&self) -> Result<UserDataRef<'_, T>>

Immutably borrow the stored value as T. Mirrors mlua::AnyUserData::borrow. Errors with Error::UserDataTypeMismatch on a type mismatch, Error::UserDataDestructed if it was taken, or Error::UserDataBorrowError if already mutably borrowed.

pub fn borrow_mut<T: 'static>(&self) -> Result<UserDataRefMut<'_, T>>

Mutably borrow the stored value as T. Mirrors mlua::AnyUserData::borrow_mut.

pub fn take<T: 'static>(&self) -> Result<T>

Take the stored value out of the userdata, leaving it destructed. Mirrors mlua::AnyUserData::take. Errors with Error::UserDataBorrowMutError if currently borrowed, or Error::UserDataDestructed if already taken.

Trait Implementations

impl Clone for AnyUserData

fn clone(&self) -> AnyUserData

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for AnyUserData

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

Formats the value using the given formatter.

impl FromLua for AnyUserData

fn from_lua(value: Value, _lua: &Lua) -> Result<Self>

Perform the conversion.

fn from_lua_arg( arg: Value, _i: usize, _to: Option<&str>, lua: &Lua, ) -> Result<Self>

Convert an argument at 1-based position i. The default forwards to FromLua::from_lua; specific impls can produce nicer messages. Mirrors mlua::FromLua::from_lua_arg.

impl IntoLua for AnyUserData

fn into_lua(self, _lua: &Lua) -> Result<Value>

Perform the conversion.

impl IntoLua for &AnyUserData

fn into_lua(self, _lua: &Lua) -> Result<Value>

Perform the conversion.

impl PartialEq for AnyUserData

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.