Crate vergen_pretty Copy item path

vergen-pretty - A pretty printer for vergen environment variables

Because cargo doesn’t pass compile time environment variables to dependencies, the vergen_pretty_env macro embeds a map of all the possible vergen environment variables with option_env!. Values not set in by your build.rs are skipped when pretty-printing the output.

§Example

let mut stdout = vec![];
Pretty::builder()
    .env(vergen_pretty_env!())
    .build()
    .display(&mut stdout)?;
assert!(!stdout.is_empty());

See the Pretty documentation for more examples

If you enable the header feature, you can also use the header() function with the associated Config as a convenience wrapper around Pretty.

§Example

let mut buf = vec![];
let config = Config::builder()
    .style(Style::new().green())
    .prefix("HEADER_PREFIX")
    .env(vergen_pretty_env!())
    .suffix("HEADER_SUFFIX")
    .build();
assert!(header(&config, Some(&mut buf)).is_ok());
assert!(!buf.is_empty());

§Features

vergen-pretty has two feature toggles allowing you to customize your output. No features are enabled by default. You must specifically enable the features you wish to use.