Struct build_script::core::BuildScript

pub struct BuildScript<'w> { /* private fields */ }

A build script. This is the main struct for creating cargo arguments.

Notes

99% of the time, you won’t need this. Instead, use the functions in basic.

Implementations

impl<'w> BuildScript<'w>

pub fn new(writer: &'w mut (dyn Write + Send)) -> Self

Create a new BuildScript.

Notes

99% of the time, you won’t need to yse this associated function. The defaults can be used instead (BuildScript::default()).

pub fn now(&mut self) -> &mut Self

Sets now to true.

pub fn build(&mut self)

Write and remove all the instructions in the stack, starting from the first.

pub fn cargo_rerun_if_changed(&mut self, path: PathBuf) -> &mut Self

Wrapper for cargo:rerun-if-changed=PATH. This tells Cargo when to rerun the script.

pub fn cargo_rerun_if_env_changed(&mut self, var: &str) -> &mut Self

Wrapper for cargo:rerun-if-env-changed=VAR. This tells Cargo when to rerun the script.

pub fn cargo_rustc_link_lib(
    &mut self,
    kind: Option<Kind>,
    name: &str
) -> &mut Self

Wrapper for cargo:rustc-link-lib=[KIND=]NAME. This adds a library to link.

pub fn cargo_rustc_link_search(
    &mut self,
    kind: Option<Kind>,
    path: PathBuf
) -> &mut Self

Wrapper for cargo:rustc-link-search=[KIND=]PATH. This adds to the library search path.

pub fn cargo_rustc_flags(&mut self, flags: &str) -> &mut Self

Wrapper for cargo:rustc-flags=FLAGS. This passes certain flags to the compiler.

pub fn cargo_rustc_cfg(&mut self, key: &str, value: Option<&str>) -> &mut Self

Wrapper for cargo:rustc-cfg=KEY[="VALUE"]. This enable compile-time cfg settings.

pub fn cargo_rustc_env(&mut self, var: &str, value: &str) -> &mut Self

Wrapper for cargo:rustc-env=VAR=VALUE. This sets an environment variable.

pub fn cargo_rustc_cdylib_link_arg(&mut self, flag: &str) -> &mut Self

Wrapper for cargo:rustc-cdylib-link-arg=FLAG. This passes custom flags to a linker for cdylib crates.

pub fn cargo_warning(&mut self, message: &str) -> &mut Self

Wrapper for cargo:warning=MESSAGE. This displays a warning on the terminal.

pub fn cargo_mapping(&mut self, key: &str, value: &str) -> &mut Self

Wrapper for cargo:KEY=VALUE. This is metadata, used by links scripts.

pub fn custom_instruction(&mut self, instruction: Instruction) -> &mut Self

Pass a custom instruction. Internally, BuildScript uses this. This may be used when build_script isn’t updated for new instructions yet in the future.

Trait Implementations

impl Default for BuildScript<'static>

fn default() -> Self

Get the default build script. Writer is io::stdout().

Notes

99% of the time, you can use this associated function instead.