Struct CompileOptions 

pub struct CompileOptions {

    pub imports: bool,
    pub condcomp: bool,
    pub visibility: bool,
    pub generics: bool,
    pub strip: bool,
    pub lower: bool,
    pub validate: bool,
    pub sourcemap: bool,
    pub mangler: ManglerKind,
    pub mangle_main: bool,
    pub keep: Option<Vec<String>>,
    pub keep_main: bool,
    pub features: Features,
    pub constants: Constants,
    pub dependencies: Vec<&'static StaticPackage>,
}

Compilation options used by Compiler.

Fields

imports: bool

Toggle WESL Imports.

If disabled:

• The compiler will silently remove all import statements and inline paths.
• Validation will not trigger an error if referencing an imported item.

condcomp: bool

Toggle WESL Conditional Translation.

See Self::features to enable/disable each feature flag.

visibility: bool

Toggle WESL Visibility

When disabled, WESL simply ignores public and private keywords on declarations and treats all declarations as public.

generics: bool

Toggle generics. Generics are super experimental, don’t expect anything from it.

Requires the generics crate feature flag.

strip: bool

Enable stripping (aka. Dead Code Elimination).

By default, all declarations reachable by entrypoint functions, const_asserts and pipeline-overridable constants in the main module are kept. See Self::keep and Self::keep_main to control what gets stripped.

Stripping can have side-effects: modules are loaded only if statically accessed, and const_assert statements are not always preserved. Refer to the WESL docs to learn more.

lower: bool

Enable lowering/polyfills. This transforms the output code in various ways.

See pass::lower for the list of transforms.

validate: bool

Enable validation of individual WESL modules and of the final output.

This will catch some errors, not all. See pass::validate_wesl and pass::validate_wgsl for the list of validations.

Requires the eval crate feature flag.

sourcemap: bool

Enable sourcemapping, which provides better error diagnostics.

mangler: ManglerKind

Declaration name mangling scheme.

mangle_main: bool

Enable mangling of declarations in the main module.

By default, WESL does not mangle main module declarations.

keep: Option<Vec<String>>

If Some, specify a list of main module declarations to keep. If None, only the entrypoint functions (and their dependencies) are kept.

This option has no effect if Self::keep_main is enabled or Self::strip is disabled.

keep_main: bool

If true, all main module declarations are preserved when stripping is enabled.

This option takes precedence over Self::keep, and has no effect if Self::strip is disabled.

features: Features

Conditional Translation feature flags.

This option has no effect if Self::condcomp is disabled.

See Features.

constants: Constants

Literal constants in the constants virtual module.

See Constants.

dependencies: Vec<&'static StaticPackage>

Importable packages dependencies.

Trait Implementations

impl Clone for CompileOptions

fn clone(&self) -> CompileOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CompileOptions

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

Formats the value using the given formatter.

impl Default for CompileOptions

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for CompileOptions

fn eq(&self, other: &CompileOptions) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for CompileOptions