Struct tlua::Object

pub struct Object<L> { /* private fields */ }

A single value stored on the lua stack. Type parameter L represents a value guarding the state of the lua stack (see PushGuard).

Use this type to convert between different lua values, e.g. LuaTable <-> Indexable, etc.

Implementations

impl<L: AsLua> Object<L>

pub fn guard(&self) -> &L

pub fn into_guard(self) -> L

pub fn index(&self) -> AbsoluteIndex

pub unsafe fn try_downcast<T>(self) -> Result<T, Self>

where T: LuaRead<L>,

Try converting to a value implementing LuaRead.

Safety

In some cases this function will result in a drop of self.guard which is invalid in case self.index is not the top of the lua stack.

Trait Implementations

impl<L> AsLua for Object<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) -> ReadResult<T, Self>

where Self: Sized, T: LuaRead<Self>,

fn read_at<T>(self, index: i32) -> ReadResult<T, Self>

where Self: Sized, T: LuaRead<Self>,

fn read_at_nz<T>(self, index: NonZeroI32) -> ReadResult<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<L> AsRef<Object<L>> for Callable<L>

where L: AsLua,

fn as_ref(&self) -> &Object<L>

Converts this type into a shared reference of the (usually inferred) input type.

impl<L> AsRef<Object<L>> for Indexable<L>

where L: AsLua,

fn as_ref(&self) -> &Object<L>

Converts this type into a shared reference of the (usually inferred) input type.

impl<L> AsRef<Object<L>> for IndexableRW<L>

where L: AsLua,

fn as_ref(&self) -> &Object<L>

Converts this type into a shared reference of the (usually inferred) input type.

impl<L> AsRef<Object<L>> for LuaFunction<L>

where L: AsLua,

fn as_ref(&self) -> &Object<L>

Converts this type into a shared reference of the (usually inferred) input type.

impl<L> AsRef<Object<L>> for LuaTable<L>

where L: AsLua,

fn as_ref(&self) -> &Object<L>

Converts this type into a shared reference of the (usually inferred) input type.

impl<L: Debug> Debug for Object<L>

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

Formats the value using the given formatter.

impl<'a, L> From<CDataOnStack<'a, L>> for Object<L>

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

Converts to this type from the input type.

impl<L> From<Callable<L>> for Object<L>

where L: AsLua,

fn from(o: Callable<L>) -> Self

Converts to this type from the input type.

impl<L> From<Indexable<L>> for Object<L>

where L: AsLua,

fn from(o: Indexable<L>) -> Self

Converts to this type from the input type.

impl<L> From<IndexableRW<L>> for Object<L>

where L: AsLua,

fn from(o: IndexableRW<L>) -> Self

Converts to this type from the input type.

impl<L> From<LuaFunction<L>> for Object<L>

where L: AsLua,

fn from(o: LuaFunction<L>) -> Self

Converts to this type from the input type.

impl<L> From<LuaTable<L>> for Object<L>

where L: AsLua,

fn from(o: LuaTable<L>) -> Self

Converts to this type from the input type.

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<L> LuaRead<L> for Object<L>

where L: AsLua,

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

Reads the data from Lua at a given position.

fn n_values_expected() -> i32

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

Reads the data from Lua.

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

where L: AsLua,

impl<L, K> Push<L> for Object<K>

where L: AsLua, K: AsLua,

type Err = Void

Error that can happen when pushing a value.

fn push_to_lua(&self, lua: L) -> PushResult<L, Self>

Pushes the value on the top of the stack.

fn push_no_err(&self, lua: L) -> PushGuard<L>

where <Self as Push<L>>::Err: Into<Void>,

Same as push_to_lua but can only succeed and is only available if Err implements Into<Void>.

impl<L, K> PushInto<L> for Object<K>

where L: AsLua, K: AsLua,

type Err = Void

fn push_into_lua(self, lua: L) -> PushIntoResult<L, Self>

Push the value into lua by value

fn push_into_no_err(self, lua: L) -> PushGuard<L>

where Self: Sized, <Self as PushInto<L>>::Err: Into<Void>,

Same as push_into_lua but can only succeed and is only available if Err implements Into<Void>.

impl<L> TryFrom<Object<L>> for CDataOnStack<'_, L>

where L: AsLua,

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.

impl<L> TryFrom<Object<L>> for Callable<L>

where L: AsLua,

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.

impl<L> TryFrom<Object<L>> for Indexable<L>

where L: AsLua,

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.

impl<L> TryFrom<Object<L>> for IndexableRW<L>

where L: AsLua,

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.

impl<L> TryFrom<Object<L>> for LuaFunction<L>

where L: AsLua,

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.

impl<L> TryFrom<Object<L>> for LuaTable<L>

where L: AsLua,

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.

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.

impl<L> PushOne<L> for Object<L>

where L: AsLua,

impl<L> PushOneInto<L> for Object<L>

where L: AsLua,