1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75

// Copyright 2018 OysterPack Inc.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

//! Provides the ability to gather information about the crate's cargo build.
//!
//! All OysterPack modules must provide build time info. This module standardizes the approach, which
//! leverages [built](https://crates.io/crates/built).
//!
//! ## How to integrate within your project
//!
//! 1. Add the following to **Cargo.toml**:
//!    ```toml
//!    [package]
//!    build = "build.rs"
//!
//!    [build-dependencies]
//!    oysterpack_built = "0.1"
//!    ```
//!
//! 2. Include the following in **build.rs**:
//!
//!    **For Library Modules**
//!    ```no_run
//!    extern crate oysterpack_built;
//!
//!    fn main() {
//!        oysterpack_built::write_library_built_file().expect("Failed to acquire build-time information");
//!    }
//!    ```
//!
//!    **For Application (Binary) Modules**
//!    ```no_run
//!    extern crate oysterpack_built;
//!
//!    fn main() {
//!        oysterpack_built::write_app_built_file().expect("Failed to acquire build-time information");
//!    }
//!    ```
//!    - includes application dependency info
//!      - **NOTE:** dependency info can only be collected for standalone projects, i.e., this will not work for projects that are part of a Cargo workspace.
//!        - Cargo.lock is used to get the application's dependencies. Since Cargo.lock is shared by all projects in a workspace, this approach won't work for workspaces.
//!
//! 3. The build script will by default write a file named **built.rs** into Cargo's output directory. It can be picked up like this:
//!    ```no_run
//!    // Use of a mod or pub mod is not actually necessary.
//!    pub mod build {
//!       // The file has been placed there by the build script.
//!       include!(concat!(env!("OUT_DIR"), "/built.rs"));
//!    }
//!    ```
//!    - `OUT_DIR` [environment variable is set by Cargo for build scripts](https://doc.rust-lang.org/cargo/reference/environment-variables.html)

#![deny(missing_docs, missing_debug_implementations, warnings)]
#![doc(html_root_url = "https://docs.rs/oysterpack_built/0.1.1")]

extern crate built;

pub mod build;

pub use build::write_app_built_file;
pub use build::write_library_built_file;

#[cfg(test)]
mod tests;