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

#![warn(missing_docs)]
/*
 * Copyright (c) 2021, 2022  Peter Pentchev <roam@ringlet.net>
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 */
//! Query a program for supported features.
//!
//! The [`obtain::obtain_features`][crate::obtain::obtain_features]
//! function queries a program for the features that it supports
//! via various methods (e.g. running it with the `--features`
//! command-line option) and allows other programs to check for
//! the presence and, possibly, versions of specific features.
//!
//! ```rust
//! # use anyhow::{bail, Result};
//!
//! use feature_check::defs::{Config, Obtained};
//! use feature_check::obtain;
//!
//! # fn main() -> Result<()> {
//! match obtain::obtain_features(&Config::default()
//!     .with_program("confget".to_string()))? {
//!     Obtained::NotSupported => eprintln!("Feature query not supported"),
//!     Obtained::Failed(err) => eprintln!("Could not query for features: {}", err),
//!     Obtained::Features(res) => {
//!         let mut features: Vec<&String> = res.keys().collect();
//!         features.sort_unstable();
//!         for name in &features {
//!             println!("{}", name);
//!         }
//!     },
//!     other => bail!(format!("Unexpected obtain_features() result: {:?}", other))
//! }
//! # Ok(())
//! # }
//! ```

#![doc(html_root_url = "https://docs.rs/feature-check/2.0.0")]

pub mod defs;
pub mod expr;
pub mod obtain;
pub mod version;