Struct LuaConfig

pub struct LuaConfig { /* private fields */ }

Implementations

impl LuaConfig

pub async fn convert_args_and_call_callback<A: Serialize>( &mut self, sig: &CallbackSignature<Value, ()>, args: A, ) -> Result<()>

Intended to be used together with kumo.spawn_task

pub fn put(self)

Explicitly put the config object back into its containing pool. Ideally we’d do this automatically when the object is dropped, but lua’s garbage collection makes this problematic: if a future whose graph contains an async lua call within this config object is cancelled (eg: simply stopped without calling it again), and the config object is not explicitly garbage collected, any futures and data owned by any dependencies of the cancelled future remain alive until the next gc run, which can cause things like async locks and semaphores to have a lifetime extended by the maximum age of the lua context.

The combat this, consumers of LuaConfig should explicitly call config.put() after successfully using the config object.

Or framing it another way: consumers must not call config.put() if a transitive dep might have been cancelled.

pub async fn async_call_callback<A: IntoLuaMulti + Clone, R: FromLuaMulti + Default>( &mut self, sig: &CallbackSignature<A, R>, args: A, ) -> Result<R>

pub async fn async_call_callback_non_default<A: IntoLuaMulti + Clone, R: FromLuaMulti>( &mut self, sig: &CallbackSignature<A, R>, args: A, ) -> Result<R>

pub async fn async_call_callback_non_default_opt<A: IntoLuaMulti + Clone, R: FromLua>( &mut self, sig: &CallbackSignature<A, Option<R>>, args: A, ) -> Result<Option<R>>

pub fn remove_registry_value(&mut self, value: RegistryKey) -> Result<()>

pub async fn async_call_ctor<A: IntoLuaMulti + Clone>( &mut self, sig: &CallbackSignature<A, Value>, args: A, ) -> Result<RegistryKey>

Call a constructor registered via on. Returns a registry key that can be used to reference the returned value again later on this same Lua instance

pub async fn with_registry_value<F, R, FUT>( &mut self, value: &RegistryKey, func: F, ) -> Result<R>

where R: FromLuaMulti, F: FnOnce(Value) -> Result<FUT>, FUT: Future<Output = Result<R>>,

Operate on an object/value that was previously constructed via async_call_ctor.

Trait Implementations

impl Debug for LuaConfig

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

Formats the value using the given formatter.