Struct Compiler

pub struct Compiler { /* private fields */ }

Available on crate feature luau only.

Luau compiler

Implementations

impl Compiler

pub const fn new() -> Self

Creates Luau compiler instance with default options

pub const fn set_optimization_level(self, level: u8) -> Self

Sets Luau compiler optimization level.

Possible values:

• 0 - no optimization
• 1 - baseline optimization level that doesn’t prevent debuggability (default)
• 2 - includes optimizations that harm debuggability such as inlining

pub const fn set_debug_level(self, level: u8) -> Self

Sets Luau compiler debug level.

Possible values:

• 0 - no debugging support
• 1 - line info & function names only; sufficient for backtraces (default)
• 2 - full debug info with local & upvalue names; necessary for debugger

pub const fn set_type_info_level(self, level: u8) -> Self

Sets Luau type information level used to guide native code generation decisions.

Possible values:

• 0 - generate for native modules (default)
• 1 - generate for all modules

pub const fn set_coverage_level(self, level: u8) -> Self

Sets Luau compiler code coverage level.

Possible values:

• 0 - no code coverage support (default)
• 1 - statement coverage
• 2 - statement and expression coverage (verbose)

pub fn set_mutable_globals<S: Into<String>>(self, globals: Vec<S>) -> Self

Sets a list of globals that are mutable.

It disables the import optimization for fields accessed through these.

pub fn set_userdata_types<S: Into<String>>(self, types: Vec<S>) -> Self

Sets a list of userdata types that will be included in the type information.

pub fn set_library_constants<L, M>( self, constants: Vec<(L, M, CompileConstant)>, ) -> Self

where L: Into<String>, M: Into<String>,

Sets constants for known library members.

The constants are used by the compiler to optimize the generated bytecode. Optimization level must be at least 2 for this to have any effect.

The first element of the tuple is the library name,the second is the member name, and the third is the constant value.

pub fn set_disabled_builtins<S: Into<String>>(self, builtins: Vec<S>) -> Self

Sets a list of builtins that should be disabled.

pub fn compile(&self, source: impl AsRef<[u8]>) -> Result<Vec<u8>>

Compiles the source into bytecode.

Returns Error::SyntaxError if the source code is invalid.

Trait Implementations

impl Clone for Compiler

fn clone(&self) -> Compiler

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Compiler

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

Formats the value using the given formatter.

impl Default for Compiler

fn default() -> Self

Returns the “default value” for a type.