Struct rlua::AnyUserData
[−]
[src]
pub struct AnyUserData<'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.
Methods
impl<'lua> AnyUserData<'lua>
[src]
fn is<T: UserData>(&self) -> Result<bool>
[src]
Checks whether the type of this userdata is T
.
fn borrow<T: 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
.
fn borrow_mut<T: 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
.
Trait Implementations
impl<'lua> ToLua<'lua> for AnyUserData<'lua>
[src]
impl<'lua> FromLua<'lua> for AnyUserData<'lua>
[src]
fn from_lua(value: Value<'lua>, _: &'lua Lua) -> Result<AnyUserData<'lua>>
[src]
Performs the conversion.
impl<'lua> Clone for AnyUserData<'lua>
[src]
fn clone(&self) -> AnyUserData<'lua>
[src]
Returns a copy of the value. Read more
fn clone_from(&mut self, source: &Self)
1.0.0[src]
Performs copy-assignment from source
. Read more