Crate build_details[][src]

Build Details

build_details is a code generation helper that provides build information at runtime.

There are two steps to adding build_details to a crate:

  • Adding/modifying build.rs; and
  • Including the generated file.

Invoking Build Details

Invoking build_details is as simple as adding the following snippet to build.rs:

extern crate build_details;

fn main() {
    build_details::BuildDetails::default()
        .generate("build_details.rs")
        .unwrap();
}

Including Generated File

In src/lib.rs:

pub mod build_details {
    include!(concat!(env!("OUT_DIR"), "/build_details.rs"));
}

A note on BuildDetail::Cfg

Using BuildDetail::Cfg requires a runtime dependency on phf.

In Cargo.toml, add:

[dependencies]
phf = "0.7"

In src/lib.rs or src/main.rs:

extern crate phf;

Modules

error

Error and Result module.

Structs

BuildDetails

Code generator for build details. See the crate documentation for an example.

Enums

BuildDetail

List of build details that can be included in the generated code.