Skip to main content

LuaFunction

Struct LuaFunction 

Source
pub struct LuaFunction { /* private fields */ }
Expand description

Handle to a Lua-callable value (Value::Closure or Value::Native) pinned in the host root pool. Copy-able — clones share the same HostRootTicket.

Becomes stale (panics on call) after Lua::unpin / Lua::unpin_all.

Implementations§

Source§

impl LuaFunction

Source

pub fn ticket(self) -> HostRootTicket

The underlying HostRootTicket. Facade-author use only.

Source

pub fn call<A, R>(self, lua: &mut Lua, args: A) -> Result<R, LuaError>

Call this function with the given typed args; decode the (first) return as R. Use LuaFunction::call_multi for the full result vector.

Source

pub fn call_multi<A>( self, lua: &mut Lua, args: A, ) -> Result<Vec<Value>, LuaError>
where A: IntoLuaArgs,

Call this function; return all results.

Trait Implementations§

Source§

impl Clone for LuaFunction

Source§

fn clone(&self) -> LuaFunction

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Copy for LuaFunction

Source§

impl Debug for LuaFunction

Source§

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

Formats the value using the given formatter. Read more
Source§

impl IntoValue for LuaFunction

Source§

fn into_value(self, vm: &mut Vm) -> Value

Convert self to a Lua Value, interning strings or allocating other GC-managed types via vm.heap as needed.
Source§

impl PinnedHandle for LuaFunction

Source§

fn ticket(&self) -> HostRootTicket

The ticket this handle wraps.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

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

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.