Struct Compiler 

pub struct Compiler { /* private fields */ }

Available on crate feature luau only.

Luau compiler

Implementations

impl Compiler

pub const fn new() -> Self

Available on crate features luau only.

Creates Luau compiler instance with default options

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

Available on crate features luau only.

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

Available on crate features luau only.

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

Available on crate features luau only.

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

Available on crate features luau only.

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 add_mutable_global(self, global: impl Into<StdString>) -> Self

Available on crate features luau only.

Adds a mutable global.

It disables the import optimization for fields accessed through it.

pub fn set_mutable_globals<S: Into<StdString>>( self, globals: impl IntoIterator<Item = S>, ) -> Self

Available on crate features luau only.

Sets a list of globals that are mutable.

It disables the import optimization for fields accessed through these.

pub fn add_userdata_type(self, type: impl Into<StdString>) -> Self

Available on crate features luau only.

Adds a userdata type to the list that will be included in the type information.

pub fn set_userdata_types<S: Into<StdString>>( self, types: impl IntoIterator<Item = S>, ) -> Self

Available on crate features luau only.

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

pub fn add_library_constant( self, name: impl AsRef<str>, const: impl Into<CompileConstant>, ) -> Self

Available on crate features luau only.

Adds a constant for a known library member.

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 name is a string in the format lib.member, where lib is the library name and member is the member (constant) name.

pub fn add_disabled_builtin(self, builtin: impl Into<StdString>) -> Self

Available on crate features luau only.

Adds a builtin that should be disabled.

pub fn set_disabled_builtins<S: Into<StdString>>( self, builtins: impl IntoIterator<Item = S>, ) -> Self

Available on crate features luau only.

Sets a list of builtins that should be disabled.

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

Available on crate features luau only.

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.

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

Available on crate features luau only.

fn default() -> Self

Returns the “default value” for a type.