build-info

Crates.iobuild-info
lib.rsbuild-info
version0.0.36
sourcesrc
created_at2020-05-28 19:52:06.963043
updated_at2024-03-11 02:51:58.620503
descriptionCollects build-information of your Rust crate.
homepage
repositoryhttps://github.com/danielschemmel/build-info/
max_upload_size
id247133
size6,632
Daniel Schemmel (danielschemmel)

documentation

README

Usage

Begin by adding build-info as a [dependency] and build-info-build as a [build-dependency] to your Cargo.toml. By separating those two crates, pure compile-time dependencies, such as git2 are not compiled into your final program. For this to work properly, ensure to opt in to resolver "2".

If it does not already exist, add a build.rs to your project's root, where you call build_info_build::build_script(). This will collect build information at compile time.

Then, either use the build_info! macro to add a function that returns version information at runtime:

build_info::build_info!(fn version);

or use build_info::format! to generate a string at compile time:

// sample output: "{sample v0.0.13 built with rustc 1.45.0-nightly (4bd32c980 2020-05-29) at 2020-05-30 11:22:46Z}"
build_info::format!("{{{} v{} built with {} at {}}}", $.crate_info.name, $.crate_info.version, $.compiler, $.timestamp)

The sample project shows both variants.

Features

The build_info crate supports several feature flags:

  • The runtime feature enables build_info::build_info!. It is enabled by default, but if you intend to only use build_info::format!, it is safe to disable this flag. Disable this feature to use build_info in a no_std context.
  • The chrono feature enables the default features of the chrono package, which is used by build_info::build_info!. It is disabled by default.
  • The serde feature adds Serialize/Deserialize support to the types used by build_info::build_info!. It is disabled by default.

Caveats

The build script will ask cargo to rerun it whenever the project or the currently checked out commit changes. It will not necessarily be rerun if only the dependencies change (build_info_build::build_script will try to find the lockfile and depend on it, but it is not really aware of any of the more intricate features, such as, cargo workspaces). Please open an issue if your specific use case requires a more strict rerun policy for build.rs and include a short description what additional files should trigger a rebuild when changed.

Copyright and license

This project is copyright its authors and licensed under either of

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in this project, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

Commit count: 266

cargo fmt