Crate nextest_metadata

Expand description

This crate contains deserializers for machine-readable output generated by cargo-nextest.

Implemented so far:

✅ Listing tests with TestListSummary
✅ Semantic exit codes with NextestExitCode

§Examples

Get the list of tests in the repository:

// This example requires `cargo nextest` to be installed.

use nextest_metadata::ListCommand;

let command = ListCommand::new();
let test_list = command.exec().unwrap();

// The result is a TestListSummary.
println!("{:?}", test_list);

§Minimum supported Rust version (MSRV)

The minimum supported Rust version is Rust 1.73.

While this crate is a pre-release (0.x.x) it may have its MSRV bumped in a patch release. Once a crate has reached 1.x, any MSRV bump will be accompanied with a new minor version.

§Minimum supported cargo-nextest version

The “minimum supported cargo-nextest version” is cargo-nextest 0.9.15.

For more about nextest-metadata’s stability policy, see the Stability page on the nextest site.

Structs§

BinaryListSummary: A serializable suite of test binaries.
BuildPlatformsSummary: Serialized representation of the host and the target platform.
HostPlatformSummary: Serialized representation of the host platform.
ListCommand: Command builder for cargo nextest list.
PlatformLibdirUnavailable: The reason why a platform libdir is unavailable.
RustBinaryId: A unique identifier for a test suite (a Rust binary).
RustBinaryIdComponents: The components of a RustBinaryId.
RustBuildMetaSummary: Rust metadata used for builds and test runs.
RustNonTestBinaryKind: Information about the kind of a Rust non-test binary.
RustNonTestBinarySummary: A non-test Rust binary. Used to set the correct environment variables in reused builds.
RustTestBinaryKind: Information about the kind of a Rust test binary.
RustTestBinarySummary: A serializable Rust test binary.
RustTestCaseSummary: Serializable information about an individual test case within a Rust test suite.
RustTestSuiteStatusSummary: Information about whether a test suite was listed or skipped.
RustTestSuiteSummary: A serializable suite of tests within a Rust test binary.
TargetPlatformSummary: Serialized representation of the target platform.
TestListSummary: Root element for a serializable list of tests generated by nextest.

Enums§

BuildPlatform: The platform a binary was built on (useful for cross-compilation)
CommandError: An error that occurs while running a cargo nextest command.
FilterMatch: An enum describing whether a test matches a filter.
MismatchReason: The reason for why a test doesn’t match a filter.
NextestExitCode: Documented exit codes for cargo nextest failures.
PlatformLibdirSummary: Serialized representation of a platform’s library directory.
RustBinaryIdNameAndKind: The name and kind of a Rust binary, present within a RustBinaryId.