pub struct Scope<'scope> { /* private fields */ }Expand description
Handle passed to the closure body of Lua::scope.
Scope::create_userdata produces an AnyUserData whose backing storage
is a borrow you provide; when the scope drops every cell it created is
invalidated. Any later Lua call that reaches one of those userdatas fails
with a clean error rather than touching freed memory.
Implementations§
Source§impl<'scope> Scope<'scope>
impl<'scope> Scope<'scope>
Sourcepub fn create_userdata_ref_mut<T>(
&self,
lua: &Lua,
data: &'scope mut T,
) -> Result<AnyUserData>where
T: UserData,
pub fn create_userdata_ref_mut<T>(
&self,
lua: &Lua,
data: &'scope mut T,
) -> Result<AnyUserData>where
T: UserData,
Wrap a &mut T borrow as a Lua userdata that lives for the duration of
this scope. Any call from Lua to the returned userdata after the scope
ends fails with a clean Lua runtime error instead of touching the
freed borrow.
Naming mirrors mlua’s Scope::create_userdata_ref_mut. The bare
create_userdata name on Scope is intentionally reserved for the
future by-value, non-'static constructor (mlua’s
Scope::create_userdata<T: UserData + 'env>(T)), tracked as a
follow-up to lua-rs#27.
Sourcepub fn create_function<A, R, F>(&self, lua: &Lua, func: F) -> Result<Function>
pub fn create_function<A, R, F>(&self, lua: &Lua, func: F) -> Result<Function>
Build a Lua Function from a non-'static Rust closure. The closure
is owned by a [ScopedFnCell] that the scope holds; once the scope
drops, the cell drops the closure and any later Lua call that reaches
the returned function fails cleanly with “no longer valid” instead of
touching the released captures.
This is the function counterpart to [Self::create_userdata] — pair
them when you want to hand Lua a &mut World plus a few closures that
also borrow from the same stack frame.
Sourcepub fn create_function_mut<A, R, F>(
&self,
lua: &Lua,
func: F,
) -> Result<Function>where
A: FromLuaMulti + 'static,
R: IntoLuaMulti + 'static,
F: FnMut(&Lua, A) -> Result<R> + 'scope,
pub fn create_function_mut<A, R, F>(
&self,
lua: &Lua,
func: F,
) -> Result<Function>where
A: FromLuaMulti + 'static,
R: IntoLuaMulti + 'static,
F: FnMut(&Lua, A) -> Result<R> + 'scope,
Like Self::create_function but accepts an FnMut. Mirrors
Lua::create_function_mut: re-entrant calls into the same closure
are rejected with an “already borrowed” runtime error rather than
producing aliasing &mut captures.