Struct BuildConfig

pub struct BuildConfig {
    pub time_phases: bool,
    pub profile: bool,
    pub metrics_outfile: Option<String>,
    pub lsp_mode: Option<LspConfig>,
    /* private fields */
}

Configuration for the overall build and compilation process.

Fields

time_phases: bool

profile: bool

metrics_outfile: Option<String>

lsp_mode: Option<LspConfig>

Implementations

impl BuildConfig

pub fn root_from_file_name_and_manifest_path( root_module: PathBuf, canonical_manifest_dir: PathBuf, build_target: BuildTarget, ) -> Self

Construct a BuildConfig from a relative path to the root module and the canonical path to the manifest directory.

The root_module path must be either canonical, or relative to the directory containing the manifest. E.g. project/src/main.sw or project/src/lib.sw.

The canonical_manifest_dir must be the canonical (aka absolute) path to the directory containing the Forc.toml file for the project. E.g. /home/user/project.

pub fn with_print_dca_graph(self, a: Option<String>) -> Self

pub fn with_print_dca_graph_url_format(self, a: Option<String>) -> Self

pub fn with_print_asm(self, print_asm: PrintAsm) -> Self

pub fn with_print_bytecode(self, bytecode: bool, bytecode_spans: bool) -> Self

pub fn with_print_ir(self, a: PrintIr) -> Self

pub fn with_time_phases(self, a: bool) -> Self

pub fn with_profile(self, a: bool) -> Self

pub fn with_metrics(self, a: Option<String>) -> Self

pub fn with_optimization_level(self, optimization_level: OptLevel) -> Self

pub fn with_include_tests(self, include_tests: bool) -> Self

Whether or not to include test functions in parsing, type-checking and codegen.

This should be set to true by invocations like forc test or forc check --tests.

Default: false

pub fn with_lsp_mode(self, lsp_mode: Option<LspConfig>) -> Self

pub fn canonical_root_module(&self) -> Arc<PathBuf>

Trait Implementations

impl Clone for BuildConfig

fn clone(&self) -> BuildConfig

Returns a copy of the value.

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

Performs copy-assignment from source.