pub struct Chunk<'lua, 'a> { /* private fields */ }
Expand description
Returned from Lua::load
and is used to finalize loading and executing Lua main chunks.
Implementations
sourceimpl<'lua, 'a> Chunk<'lua, 'a>
impl<'lua, 'a> Chunk<'lua, 'a>
sourcepub fn set_name<S: AsRef<[u8]> + ?Sized>(self, name: &S) -> Result<Self>
pub fn set_name<S: AsRef<[u8]> + ?Sized>(self, name: &S) -> Result<Self>
Sets the name of this chunk, which results in more informative error traces.
sourcepub fn set_environment<V: ToLua<'lua>>(self, env: V) -> Result<Self>
pub fn set_environment<V: ToLua<'lua>>(self, env: V) -> Result<Self>
Sets the first upvalue (_ENV
) of the loaded chunk to the given value.
Lua main chunks always have exactly one upvalue, and this upvalue is used as the _ENV
variable inside the chunk. By default this value is set to the global environment.
Calling this method changes the _ENV
upvalue to the value provided, and variables inside
the chunk will refer to the given environment rather than the global one.
All global variables (including the standard library!) are looked up in _ENV
, so it may be
necessary to populate the environment in order for scripts using custom environments to be
useful.
sourcepub fn set_mode(self, mode: ChunkMode) -> Self
pub fn set_mode(self, mode: ChunkMode) -> Self
Sets whether the chunk is text or binary (autodetected by default).
Be aware, Lua does not check the consistency of the code inside binary chunks. Running maliciously crafted bytecode can crash the interpreter.
sourcepub fn set_optimization_level(self, level: u8) -> Self
This is supported on crate feature luau
only.
pub fn set_optimization_level(self, level: u8) -> Self
luau
only.Sets Luau compiler optimization level.
See Compiler::set_optimization_level
for details.
Requires feature = "luau"
sourcepub fn set_debug_level(self, level: u8) -> Self
This is supported on crate feature luau
only.
pub fn set_debug_level(self, level: u8) -> Self
luau
only.sourcepub fn set_coverage_level(self, level: u8) -> Self
This is supported on crate feature luau
only.
pub fn set_coverage_level(self, level: u8) -> Self
luau
only.Sets Luau compiler code coverage level.
See Compiler::set_coverage_level
for details.
Requires feature = "luau"
sourcepub fn set_mutable_globals(self, globals: Vec<String>) -> Self
This is supported on crate feature luau
only.
pub fn set_mutable_globals(self, globals: Vec<String>) -> Self
luau
only.Sets a list of globals that are mutable for Luau compiler.
See Compiler::set_mutable_globals
for details.
Requires feature = "luau"
sourcepub fn exec(self) -> Result<()>
pub fn exec(self) -> Result<()>
Execute this chunk of code.
This is equivalent to calling the chunk function with no arguments and no return values.
sourcepub fn exec_async<'fut>(self) -> LocalBoxFuture<'fut, Result<()>> where
'lua: 'fut,
This is supported on crate feature async
only.
pub fn exec_async<'fut>(self) -> LocalBoxFuture<'fut, Result<()>> where
'lua: 'fut,
async
only.sourcepub fn eval<R: FromLuaMulti<'lua>>(self) -> Result<R>
pub fn eval<R: FromLuaMulti<'lua>>(self) -> Result<R>
Evaluate the chunk as either an expression or block.
If the chunk can be parsed as an expression, this loads and executes the chunk and returns
the value that it evaluates to. Otherwise, the chunk is interpreted as a block as normal,
and this is equivalent to calling exec
.
sourcepub fn eval_async<'fut, R>(self) -> LocalBoxFuture<'fut, Result<R>> where
'lua: 'fut,
R: FromLuaMulti<'lua> + 'fut,
This is supported on crate feature async
only.
pub fn eval_async<'fut, R>(self) -> LocalBoxFuture<'fut, Result<R>> where
'lua: 'fut,
R: FromLuaMulti<'lua> + 'fut,
async
only.Asynchronously evaluate the chunk as either an expression or block.
See eval
for more details.
Requires feature = "async"
sourcepub fn call<A: ToLuaMulti<'lua>, R: FromLuaMulti<'lua>>(
self,
args: A
) -> Result<R>
pub fn call<A: ToLuaMulti<'lua>, R: FromLuaMulti<'lua>>(
self,
args: A
) -> Result<R>
Load the chunk function and call it with the given arguments.
This is equivalent to into_function
and calling the resulting function.
sourcepub fn call_async<'fut, A, R>(self, args: A) -> LocalBoxFuture<'fut, Result<R>> where
'lua: 'fut,
A: ToLuaMulti<'lua>,
R: FromLuaMulti<'lua> + 'fut,
This is supported on crate feature async
only.
pub fn call_async<'fut, A, R>(self, args: A) -> LocalBoxFuture<'fut, Result<R>> where
'lua: 'fut,
A: ToLuaMulti<'lua>,
R: FromLuaMulti<'lua> + 'fut,
async
only.Load the chunk function and asynchronously call it with the given arguments.
See call
for more details.
Requires feature = "async"
sourcepub fn into_function(self) -> Result<Function<'lua>>
pub fn into_function(self) -> Result<Function<'lua>>
Load this chunk into a regular Function
.
This simply compiles the chunk without actually executing it.
Auto Trait Implementations
impl<'lua, 'a> !RefUnwindSafe for Chunk<'lua, 'a>
impl<'lua, 'a> !Send for Chunk<'lua, 'a>
impl<'lua, 'a> !Sync for Chunk<'lua, 'a>
impl<'lua, 'a> Unpin for Chunk<'lua, 'a>
impl<'lua, 'a> !UnwindSafe for Chunk<'lua, 'a>
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more