Struct tlua::UserdataOnStack

pub struct UserdataOnStack<'a, T, L: 'a> { /* private fields */ }

Represents a user data located inside the Lua context.

Trait Implementations

impl<T, L> AsLua for UserdataOnStack<'_, T, L> where
    L: AsLua, 

fn as_lua(&self) -> LuaState

fn try_push<T>(
    self,
    v: T
) -> Result<PushGuard<Self>, (<T as PushInto<Self>>::Err, Self)> where
    Self: Sized,
    T: PushInto<Self>, 

Try to push v onto the lua stack.

fn push<T>(self, v: T) -> PushGuard<Self> where
    Self: Sized,
    T: PushInto<Self>,
    <T as PushInto<Self>>::Err: Into<Void>, 

Push v onto the lua stack.

fn try_push_one<T>(
    self,
    v: T
) -> Result<PushGuard<Self>, (<T as PushInto<Self>>::Err, Self)> where
    Self: Sized,
    T: PushOneInto<Self>, 

Try to push v onto the lua stack.

fn push_one<T>(self, v: T) -> PushGuard<Self> where
    Self: Sized,
    T: PushOneInto<Self>,
    <T as PushInto<Self>>::Err: Into<Void>, 

Push v onto the lua stack.

fn push_iter<I>(self, iterator: I) -> Result<PushGuard<Self>, Self> where
    Self: Sized,
    I: Iterator,
    <I as Iterator>::Item: PushInto<LuaState>,
    <<I as Iterator>::Item as PushInto<LuaState>>::Err: Into<Void>, 

Push iterator onto the lua stack as a lua table.

fn try_push_iter<I>(
    self,
    iterator: I
) -> Result<PushGuard<Self>, (PushIterErrorOf<I>, Self)> where
    Self: Sized,
    I: Iterator,
    <I as Iterator>::Item: PushInto<LuaState>, 

Push iterator onto the lua stack as a lua table.

fn read<T>(self) -> Result<T, Self> where
    Self: Sized,
    T: LuaRead<Self>, 

fn read_at<T>(self, index: i32) -> Result<T, Self> where
    Self: Sized,
    T: LuaRead<Self>, 

fn read_at_nz<T>(self, index: NonZeroI32) -> Result<T, Self> where
    Self: Sized,
    T: LuaRead<Self>, 

fn pcall<F, R>(&self, f: F) -> Result<R, LuaError> where
    F: FnOnce(StaticLua) -> R, 

Call a rust function in protected mode. If a lua error is thrown during execution of f the function will return a LuaError.

impl<'a, T: Debug, L: Debug + 'a> Debug for UserdataOnStack<'a, T, L>

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

Formats the value using the given formatter.

impl<T, L> Deref for UserdataOnStack<'_, T, L>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &T

Dereferences the value.

impl<T, L> DerefMut for UserdataOnStack<'_, T, L>

fn deref_mut(&mut self) -> &mut T

Mutably dereferences the value.

impl<'a, T, L> From<UserdataOnStack<'a, T, L>> for Object<L>

fn from(ud: UserdataOnStack<'a, T, L>) -> Self

Converts to this type from the input type.

impl<T, L> LuaRead<L> for UserdataOnStack<'_, T, L> where
    L: AsLua,
    T: Any, 

fn lua_read_at_position(lua: L, index: NonZeroI32) -> Result<Self, L>

Reads the data from Lua at a given position.

fn n_values_expected() -> i32

fn lua_read(lua: L) -> Result<Self, L>

Reads the data from Lua.

fn lua_read_at_maybe_zero_position(lua: L, index: i32) -> Result<Self, L>

impl<T, L> TryFrom<Object<L>> for UserdataOnStack<'_, T, L> where
    L: AsLua,
    T: Any, 

type Error = Object<L>

The type returned in the event of a conversion error.

fn try_from(o: Object<L>) -> Result<Self, Self::Error>

Performs the conversion.