Struct sandkiste_lua::v5_3::LuaFunction

pub struct LuaFunction<'a, 'b> { /* private fields */ }

Lua function

A function inside the Lua machine can be referenced from Rust through a LuaFunction. See Function trait for information on how to use this type.

Lifetimes

Lifetime argument 'a corresponds to the lifetime argument 'a of LuaMachine. It is a lower bound for closures passed to the Lua machine.

Lifetime argument 'b corresponds to the lifetime of the shared reference to the LuaMachine being worked with.

Trait Implementations

impl<'a, 'b> Clone for LuaFunction<'a, 'b>

fn clone(&self) -> LuaFunction<'a, 'b>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a, 'b> Debug for LuaFunction<'a, 'b>

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

Formats the value using the given formatter.

impl<'a, 'b> Function for LuaFunction<'a, 'b>

type Datum<'c> = LuaDatum<'a, 'b, 'c>

Type used for arguments and return values

fn chunk_name(&self) -> Option<&str>

Chunk name which was used to create function (if known)

fn call<'c, A>(
    &self,
    args: A
) -> Result<Vec<LuaDatum<'a, 'b, 'static>>, MachineError> where
    A: IntoIterator<Item = LuaDatum<'a, 'b, 'c>>,
    <A as IntoIterator>::IntoIter: ExactSizeIterator, 

Call the function

fn call_expect_retvals<'c, A>(
    &self,
    count: usize,
    args: A
) -> Result<Vec<Self::Datum<'static>, Global>, MachineError> where
    A: IntoIterator<Item = Self::Datum<'c>>,
    <A as IntoIterator>::IntoIter: ExactSizeIterator, 

Same as Function::call but expects a fixed number of return values

fn call_expect_min_retvals<'c, A>(
    &self,
    count: usize,
    args: A
) -> Result<Vec<Self::Datum<'static>, Global>, MachineError> where
    A: IntoIterator<Item = Self::Datum<'c>>,
    <A as IntoIterator>::IntoIter: ExactSizeIterator, 

Same as Function::call but expects a minimum number of return values

fn call_1ret<'c, A>(
    &self,
    args: A
) -> Result<Self::Datum<'static>, MachineError> where
    A: IntoIterator<Item = Self::Datum<'c>>,
    <A as IntoIterator>::IntoIter: ExactSizeIterator, 

Same as Function::call but expects exactly one return value

fn call_2ret<'c, A>(
    &self,
    args: A
) -> Result<(Self::Datum<'static>, Self::Datum<'static>), MachineError> where
    A: IntoIterator<Item = Self::Datum<'c>>,
    <A as IntoIterator>::IntoIter: ExactSizeIterator, 

Same as Function::call but expects exactly two return values

fn call_3ret<'c, A>(
    &self,
    args: A
) -> Result<(Self::Datum<'static>, Self::Datum<'static>, Self::Datum<'static>), MachineError> where
    A: IntoIterator<Item = Self::Datum<'c>>,
    <A as IntoIterator>::IntoIter: ExactSizeIterator, 

Same as Function::call but expects exactly three return values

impl<'a, 'b> Hash for LuaFunction<'a, 'b>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl<'a, 'b> PartialEq<LuaFunction<'a, 'b>> for LuaFunction<'a, 'b>

fn eq(&self, other: &LuaFunction<'a, 'b>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &LuaFunction<'a, 'b>) -> bool

This method tests for !=.

impl<'a, 'b> Eq for LuaFunction<'a, 'b>

impl<'a, 'b> StructuralEq for LuaFunction<'a, 'b>

impl<'a, 'b> StructuralPartialEq for LuaFunction<'a, 'b>