Struct mlua::prelude::LuaAnyUserData [−][src]
pub struct LuaAnyUserData<'lua>(_);
Handle to an internal Lua userdata for any type that implements UserData
.
Similar to std::any::Any
, this provides an interface for dynamic type checking via the is
and borrow
methods.
Internally, instances are stored in a RefCell
, to best match the mutable semantics of the Lua
language.
Note
This API should only be used when necessary. Implementing UserData
already allows defining
methods which check the type and acquire a borrow behind the scenes.
Implementations
impl<'lua> AnyUserData<'lua>
[src]
impl<'lua> AnyUserData<'lua>
[src]pub fn is<T: 'static + UserData>(&self) -> bool
[src]
Checks whether the type of this userdata is T
.
pub fn borrow<T: 'static + UserData>(&self) -> Result<Ref<'_, T>>
[src]
Borrow this userdata immutably if it is of type T
.
Errors
Returns a UserDataBorrowError
if the userdata is already mutably borrowed. Returns a
UserDataTypeMismatch
if the userdata is not of type T
.
pub fn borrow_mut<T: 'static + UserData>(&self) -> Result<RefMut<'_, T>>
[src]
Borrow this userdata mutably if it is of type T
.
Errors
Returns a UserDataBorrowMutError
if the userdata is already borrowed. Returns a
UserDataTypeMismatch
if the userdata is not of type T
.
pub fn set_user_value<V: ToLua<'lua>>(&self, v: V) -> Result<()>
[src]
Sets an associated value to this AnyUserData
.
The value may be any Lua value whatsoever, and can be retrieved with get_user_value
.
As Lua < 5.3 allows to store only tables, the value will be stored in a table at index 1.
pub fn get_user_value<V: FromLua<'lua>>(&self) -> Result<V>
[src]
Returns an associated value set by set_user_value
.
For Lua < 5.3 the value will be automatically extracted from the table wrapper from index 1.
pub fn get_metatable(&self) -> Result<UserDataMetatable<'lua>>
[src]
Returns a metatable of this UserData
.
Returned UserDataMetatable
object wraps the original metatable and
provides safe access to it methods.
For T: UserData + 'static
returned metatable is shared among all instances of type T
.
pub fn has_metamethod(&self, method: MetaMethod) -> Result<bool>
[src]
Please use the get_metatable function instead
Checks for a metamethod in this AnyUserData
.
This function is deprecated and will be removed in v0.7.
Please use get_metatable
function instead.
Trait Implementations
impl<'lua> AsRef<AnyUserData<'lua>> for AnyUserData<'lua>
[src]
impl<'lua> AsRef<AnyUserData<'lua>> for AnyUserData<'lua>
[src]impl<'lua> Clone for AnyUserData<'lua>
[src]
impl<'lua> Clone for AnyUserData<'lua>
[src]fn clone(&self) -> AnyUserData<'lua>
[src]
pub fn clone_from(&mut self, source: &Self)
1.0.0[src]
impl<'lua> FromLua<'lua> for AnyUserData<'lua>
[src]
impl<'lua> FromLua<'lua> for AnyUserData<'lua>
[src]impl<'lua> PartialEq<AnyUserData<'lua>> for AnyUserData<'lua>
[src]
impl<'lua> PartialEq<AnyUserData<'lua>> for AnyUserData<'lua>
[src]impl<'lua> Serialize for AnyUserData<'lua>
[src]
impl<'lua> Serialize for AnyUserData<'lua>
[src]Auto Trait Implementations
impl<'lua> !RefUnwindSafe for AnyUserData<'lua>
impl<'lua> !RefUnwindSafe for AnyUserData<'lua>
impl<'lua> !Send for AnyUserData<'lua>
impl<'lua> !Send for AnyUserData<'lua>
impl<'lua> !Sync for AnyUserData<'lua>
impl<'lua> !Sync for AnyUserData<'lua>
impl<'lua> Unpin for AnyUserData<'lua>
impl<'lua> Unpin for AnyUserData<'lua>
impl<'lua> !UnwindSafe for AnyUserData<'lua>
impl<'lua> !UnwindSafe for AnyUserData<'lua>