Struct zng::hot_reload::BuildArgs

pub struct BuildArgs {
    pub manifest_dir: Txt,
    pub cancel_build: SignalOnce,
}

Arguments for custom rebuild runners.

See HOT_RELOAD.rebuilder for more details.

Fields

manifest_dir: Txt

Crate that changed.

cancel_build: SignalOnce

Cancel signal.

If the build cannot be cancelled or has already finished this signal must be ignored and the normal result returned.

Implementations

impl BuildArgs

pub fn build( &self, package: Option<&str>, ) -> Option<ReadOnlyVar<Response<Result<PathBuf, BuildError>>, ArcVar<Response<Result<PathBuf, BuildError>>>>>

Calls cargo build [--package {package}] --message-format json and cancels it as soon as the dylib is rebuilt.

Always returns Some(_).

pub fn build_example( &self, package: Option<&str>, example: &str, ) -> Option<ReadOnlyVar<Response<Result<PathBuf, BuildError>>, ArcVar<Response<Result<PathBuf, BuildError>>>>>

Calls cargo build [--package {package}] --example {example} --message-format json and cancels it as soon as the dylib is rebuilt.

Always returns Some(_).

pub fn build_bin( &self, package: Option<&str>, bin: &str, ) -> Option<ReadOnlyVar<Response<Result<PathBuf, BuildError>>, ArcVar<Response<Result<PathBuf, BuildError>>>>>

Calls cargo build [--package {package}] --bin {bin} --message-format json and cancels it as soon as the dylib is rebuilt.

Always returns Some(_).

pub fn build_manifest( &self, path: &str, ) -> Option<ReadOnlyVar<Response<Result<PathBuf, BuildError>>, ArcVar<Response<Result<PathBuf, BuildError>>>>>

Calls cargo build --manifest-path {path} --message-format json and cancels it as soon as the dylib is rebuilt.

Always returns Some(_).

pub fn custom( &self, cmd: Command, ) -> Option<ReadOnlyVar<Response<Result<PathBuf, BuildError>>, ArcVar<Response<Result<PathBuf, BuildError>>>>>

Calls a custom command that must write to stdout the same way cargo build --message-format json does.

The command will run until it writes the "compiler-artifact" for the manifest_dir/Cargo.toml to stdout, it will then be killed.

Always returns Some(_).

pub fn custom_env( &self, var_key: &str, ) -> Option<ReadOnlyVar<Response<Result<PathBuf, BuildError>>, ArcVar<Response<Result<PathBuf, BuildError>>>>>

Call a custom command defined in an environment var.

The variable value must be arguments for cargo, that is cargo $VAR.

See custom for other requirements of the command.

If var_key is empty the default key "ZNG_HOT_RELOAD_REBUILDER" is used.

Returns None if the var is not found or is set empty.

pub fn default_build( &self, ) -> Option<ReadOnlyVar<Response<Result<PathBuf, BuildError>>, ArcVar<Response<Result<PathBuf, BuildError>>>>>

The default action.

Tries custom_env, if env is not set, does build(None).

Always returns Some(_).

Trait Implementations

impl Clone for BuildArgs

fn clone(&self) -> BuildArgs

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for BuildArgs

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

Formats the value using the given formatter.

impl PartialEq for BuildArgs

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for BuildArgs