[−][src]Struct rlua::prelude::LuaAnyUserData
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]
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
.
pub fn get_user_value<V: FromLua<'lua>>(&self) -> Result<V>
[src]
Returns an associated value set by set_user_value
.
Trait Implementations
impl<'lua> ToLua<'lua> for AnyUserData<'lua>
[src]
impl<'lua> FromLua<'lua> for AnyUserData<'lua>
[src]
impl<'lua> Clone for AnyUserData<'lua>
[src]
fn clone(&self) -> AnyUserData<'lua>
[src]
fn clone_from(&mut self, source: &Self)
1.0.0[src]
impl<'lua> Debug for AnyUserData<'lua>
[src]
Auto Trait Implementations
impl<'lua> !Send for AnyUserData<'lua>
impl<'lua> !Sync for AnyUserData<'lua>
impl<'lua> Unpin for AnyUserData<'lua>
impl<'lua> !UnwindSafe for AnyUserData<'lua>
impl<'lua> !RefUnwindSafe for AnyUserData<'lua>
Blanket Implementations
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> From<T> for T
[src]
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
fn to_owned(&self) -> T
[src]
fn clone_into(&self, target: &mut T)
[src]
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
[src]
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,