nextest_metadata/lib.rs
1// Copyright (c) The nextest Contributors
2// SPDX-License-Identifier: MIT OR Apache-2.0
3
4//! This crate contains deserializers for machine-readable output generated by
5//! [cargo-nextest](https://nexte.st).
6//!
7//! Implemented so far:
8//! * ✅ Listing tests with [`TestListSummary`]
9//! * ✅ Semantic exit codes with [`NextestExitCode`]
10//!
11//! # Examples
12//!
13//! Get the list of tests in the repository:
14//!
15//! ```rust
16//! // This example requires `cargo nextest` to be installed.
17//!
18//! use nextest_metadata::ListCommand;
19//!
20//! let command = ListCommand::new();
21//! let test_list = command.exec().unwrap();
22//!
23//! // The result is a TestListSummary.
24//! println!("{:?}", test_list);
25//! ```
26//!
27//! # Minimum supported Rust version (MSRV)
28//!
29//! The minimum supported Rust version is **Rust 1.73.**
30//!
31//! While this crate is a pre-release (0.x.x) it may have its MSRV bumped in a patch release. Once a
32//! crate has reached 1.x, any MSRV bump will be accompanied with a new minor version.
33//!
34//! # Minimum supported cargo-nextest version
35//!
36//! The "minimum supported cargo-nextest version" is **cargo-nextest 0.9.15**.
37//!
38//! For more about nextest-metadata's stability policy, see the [Stability
39//! page](https://nexte.st/docs/stability/#nextest-metadata) on the nextest site.
40#![warn(missing_docs)]
41
42mod errors;
43mod exit_codes;
44mod test_list;
45
46pub use errors::*;
47pub use exit_codes::*;
48pub use test_list::*;