Struct CompileOptions

pub struct CompileOptions {
    pub kind: ModuleKind,
    pub warnings_as_errors: bool,
    pub path: Option<LibraryPath>,
}

The set of options which can be used to control the behavior of the Compile trait.

Fields

kind: ModuleKind

The kind of Module to compile.

The default kind is executable.

warnings_as_errors: bool

When true, promote warning diagnostics to errors

path: Option<LibraryPath>

The name to give the compiled Module

This option overrides namespace.

If unset, and there is no name associated with the item being compiled (e.g. a file path) then the path will consist of just a namespace; using the value of namespace if provided, or deriving one from kind.

Implementations

impl Options

pub fn new<P, E>(kind: ModuleKind, path: P) -> Result<Options, E>

where P: TryInto<LibraryPath, Error = E>,

Configure a set of Options to compile a Module with the given kind and path.

This is primarily useful when compiling a module from source code that has no meaningful LibraryPath associated with it, such as when compiling from a str. This will override the default name derived from the given ModuleKind.

pub fn for_library() -> Options

Get the default Options for compiling a library module.

pub fn for_kernel() -> Options

Get the default Options for compiling a kernel module.

Trait Implementations

impl Clone for Options

fn clone(&self) -> Options

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Options

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

Formats the value using the given formatter.

impl Default for Options

fn default() -> Options

Returns the “default value” for a type.