build_info_build/
lib.rs

1/*!
2This crate is used to collect build info for consumption by the `build-info` crate.
3
4```rust,no_run
5// Calling `build_info_build::build_script` collects all data and makes it available to `build_info::build_info!`
6// and `build_info::format!` in the main program.
7build_info_build::build_script();
8```
9
10# Features
11The `build-info-build` crate has the following features:
12
13- `git` (enabled by default): Enables git support. A git repository will only be detected if this feature is available.
14*/
15
16#![forbid(unsafe_code)]
17#![allow(clippy::tabs_in_doc_comments)]
18
19pub use build_info_common::{
20	BuildInfo, CompilerChannel, CompilerInfo, CrateInfo, GitInfo, OptimizationLevel, VersionControl, semver,
21};
22
23mod build_script_options;
24pub use build_script_options::{BuildScriptOptions, DependencyDepth};
25
26/// Call this function in your `build.rs` script to generate the data consumed by the `build_info` crate.
27/// Additional customization options are available by manipulating the return type.
28/// The actual work is performed once the return type is dropped.
29pub fn build_script() -> BuildScriptOptions {
30	BuildScriptOptions::default()
31}