proptest/
lib.rs

1//-
2// Copyright 2017, 2018 Jason Lingle
3//
4// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
5// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
6// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
7// option. This file may not be copied, modified, or distributed
8// except according to those terms.
9
10//! # Proptest Reference Documentation
11//!
12//! This is the reference documentation for the proptest API.
13//!
14//! For documentation on how to get started with proptest and general usage
15//! advice, please refer to the [Proptest Book](https://altsysrq.github.io/proptest-book/intro.html).
16
17#![forbid(future_incompatible)]
18#![deny(missing_docs, bare_trait_objects)]
19#![no_std]
20#![cfg_attr(feature = "cargo-clippy", allow(
21    doc_markdown,
22    // We have a lot of these lints for associated types... And we don't care.
23    type_complexity
24))]
25#![cfg_attr(
26    feature = "unstable",
27    feature(
28        allocator_api,
29        try_trait,
30        generator_trait,
31        never_type,
32        try_reserve
33    )
34)]
35#![cfg_attr(all(feature = "std", feature = "unstable"), feature(ip))]
36#![cfg_attr(
37    all(feature = "alloc", not(feature = "std")),
38    feature(core_intrinsics)
39)]
40
41// std_facade is used in a few macros, so it needs to be public.
42#[macro_use]
43#[doc(hidden)]
44pub mod std_facade;
45
46#[cfg(any(feature = "std", test))]
47#[macro_use]
48extern crate std;
49
50#[cfg(all(feature = "alloc", not(feature = "std")))]
51#[macro_use]
52extern crate alloc;
53
54#[cfg(feature = "frunk")]
55#[macro_use]
56extern crate frunk_core;
57
58#[cfg(feature = "frunk")]
59#[macro_use]
60mod product_frunk;
61
62#[cfg(not(feature = "frunk"))]
63#[macro_use]
64mod product_tuple;
65
66#[macro_use]
67extern crate bitflags;
68#[cfg(feature = "bit-set")]
69extern crate bit_set;
70
71#[cfg(feature = "std")]
72#[macro_use]
73extern crate lazy_static;
74
75// Only required for the string module.
76#[cfg(feature = "std")]
77#[macro_use]
78extern crate quick_error;
79
80#[cfg(feature = "fork")]
81#[macro_use]
82extern crate rusty_fork;
83
84#[macro_use]
85mod macros;
86
87#[doc(hidden)]
88#[macro_use]
89pub mod sugar;
90
91pub mod arbitrary;
92pub mod array;
93pub mod bits;
94pub mod bool;
95pub mod char;
96pub mod collection;
97pub mod num;
98pub mod strategy;
99pub mod test_runner;
100pub mod tuple;
101
102pub mod option;
103pub mod result;
104pub mod sample;
105#[cfg(feature = "std")]
106pub mod string;
107
108pub mod prelude;
proptest/lib.rs

proptest/
lib.rs
