Struct tlua::Callable

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

An opaque value on lua stack that can be called. Can represent a lua function, a lua table with a __call metamethod or other callable lua value.

Use this type when reading return values from lua functions or getting lua function from tables.

Trait Implementations

impl<L> AsLua for Callable<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> Call<L> for Callable<L>where L: AsLua,

fn call<'lua, R>(&'lua self) -> Result<R, LuaError>where L: 'lua, R: LuaRead<PushGuard<&'lua L>>,

fn call_with<'lua, A, R>(&'lua self, args: A) -> Result<R, CallError<A::Err>>where L: 'lua, A: PushInto<LuaState>, R: LuaRead<PushGuard<&'lua L>>,

fn into_call<R>(self) -> Result<R, LuaError>where Self: AsLua + Sized, R: LuaRead<PushGuard<Self>>,

fn into_call_with<A, R>(self, args: A) -> Result<R, CallError<A::Err>>where Self: AsLua + Sized, A: PushInto<LuaState>, R: LuaRead<PushGuard<Self>>,

impl<L: Debug> Debug for Callable<L>

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

Formats the value using the given formatter.

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> LuaRead<L> for Callable<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, T> Push<L> for Callable<T>where L: AsLua, T: 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> 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, T> PushOne<L> for Callable<T>where L: AsLua, T: AsLua,