Struct seacan::bin::Compiler

pub struct Compiler { /* fields omitted */ }

Compile a binary

let artifact = Compiler::bin("hello_world")
    .workspace("samples/hello_world")
    .features(FeatureSpec::new(vec!["non_default_feature".into()]))
    .release(true)
    .compile()?;

Implementations

impl Compiler

#[must_use]

pub fn bin(name: impl Into<String>) -> Self

Compile a binary.

Note: By default the default binary has the name of the crate.

#[must_use]

pub fn example(name: impl Into<String>) -> Self

Compile an example.

pub fn workspace(&mut self, path: impl Into<PathBuf>) -> &mut Self

The directory to run cargo in.

By default the current working directory.

pub fn package(&mut self, package: PackageSpec) -> &mut Self

The package the binary is in.

By default PackageSpec::Any.

pub fn on_compiler_msg(
    &mut self,
    cb: impl FnMut(CompilerMessage) + 'static
) -> &mut Self

Callback for compiler messages.

Regardless of if you specify this compiler messages will be logged at debug level using tracing.

pub fn target_dir(&mut self, target_dir: impl Into<Utf8PathBuf>) -> &mut Self

Where to put the build artifacts.

By default this is whatever cargo chooses by default.

pub fn features(&mut self, features: FeatureSpec) -> &mut Self

Enable or disable feature flags.

By default this is whatever cargo chooses by default.

pub fn release(&mut self, is_release: bool) -> &mut Self

If we should build in release mode.

pub fn compile(&mut self) -> Result<ExecutableArtifact, BuildError>

Compile the described executable

Trait Implementations

impl Debug for Compiler

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

Formats the value using the given formatter.