Struct Cargo

pub struct Cargo { /* private fields */ }

Available on crate feature cargo only.

Configure the emission of VERGEN_CARGO_* instructions

NOTE - All cargo instructions are considered deterministic. If you change the version of cargo you are compiling with, these values should change if being used in the generated binary.

Variable	Sample
VERGEN_CARGO_DEBUG	true
VERGEN_CARGO_FEATURES	git,build
VERGEN_CARGO_OPT_LEVEL	1
VERGEN_CARGO_TARGET_TRIPLE	x86_64-unknown-linux-gnu

Example

Emit all of the cargo instructions

fn main() -> Result<()> {
    temp_env::with_vars([
        ("CARGO_FEATURE_BUILD", Some("")),
        ("DEBUG", Some("true")),
        ("OPT_LEVEL", Some("1")),
        ("TARGET", Some("x86_64-unknown-linux-gnu"))
    ], || {
        let cargo = CargoBuilder::all_cargo()?;
        Emitter::default().add_instructions(&cargo)?.emit()?;
    });

Emit some of the cargo instructions

    temp_env::with_vars([
        ("OPT_LEVEL", Some("1")),
        ("TARGET", Some("x86_64-unknown-linux-gnu"))
    ], || {
        let cargo = CargoBuilder::default().opt_level(true).build()?;
        Emitter::default().add_instructions(&cargo)?.emit()?;
    });

Override output with your own value

fn main() -> Result<()> {
    temp_env::with_vars([
        ("CARGO_FEATURE_BUILD", Some("")),
        ("VERGEN_CARGO_DEBUG", Some("my own debug value")),
        ("OPT_LEVEL", Some("1")),
        ("TARGET", Some("x86_64-unknown-linux-gnu"))
     ], || {
         let cargo = CargoBuilder::all_cargo()?;
         Emitter::default().add_instructions(&cargo)?.emit()?;
     });

Implementations

impl Cargo

pub fn set_name_filter(&mut self, val: Option<&'static str>) -> &mut Self

Add a name Regex filter for cargo dependencies

cargo:rustc-env=VERGEN_CARGO_DEPENDENCIES=<deps_filtered_by_name>

pub fn set_dep_kind_filter(&mut self, val: Option<DependencyKind>) -> &mut Self

Add a DependencyKind filter for cargo dependencies

cargo:rustc-env=VERGEN_CARGO_DEPENDENCIES=<deps_filtered_by_kind>

Trait Implementations

impl Add for Cargo

fn add_map_entries( &self, _idempotent: bool, cargo_rustc_env: &mut CargoRustcEnvMap, _cargo_rerun_if_changed: &mut CargoRerunIfChanged, _cargo_warning: &mut CargoWarning, ) -> Result<()>

Try to add instructions entries to the various given arguments.

fn add_default_entries( &self, config: &DefaultConfig, cargo_rustc_env_map: &mut CargoRustcEnvMap, _cargo_rerun_if_changed: &mut CargoRerunIfChanged, cargo_warning: &mut CargoWarning, ) -> Result<()>

Based on the given configuration, emit either default idempotent output or generate a failue.

impl Clone for Cargo

fn clone(&self) -> Cargo

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Cargo

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

Formats the value using the given formatter.

impl PartialEq for Cargo

fn eq(&self, other: &Cargo) -> 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 Copy for Cargo

impl StructuralPartialEq for Cargo