claim/lib.rs
1#![cfg_attr(rustc_1_6, no_std)]
2#![doc(html_root_url = "https://docs.rs/claim/0.5.0")]
3#![allow(unknown_lints, unused_extern_crates)]
4#![forbid(
5 rust_2018_idioms,
6 unused,
7 unused_imports,
8 unused_features,
9 bare_trait_objects,
10 future_incompatible,
11 missing_debug_implementations,
12 missing_docs,
13 nonstandard_style,
14 dead_code,
15 deprecated,
16 broken_intra_doc_links,
17 trivial_casts,
18 trivial_numeric_casts,
19 unused_import_braces,
20 unused_results,
21 unsafe_code
22)]
23
24//! Assertion macros.
25//!
26//! This crate provides additional assert macros to make testing a bit easier.
27//!
28//! ## `#![no_std]` support
29//!
30//! `claim` can be used in a `no-std` environments too.
31//!
32//! ## Available macros
33//!
34//! Note that same to [`core`]/[`std`] macros,
35//! all macros in this crate has the [`debug_*`](#macros) counterparts.
36//!
37//! ### Comparison
38//!
39//! Assertions similar to [`assert_eq`] or [`assert_ne`]:
40//!
41//! * [`assert_ge`]
42//! * [`assert_gt`]
43//! * [`assert_le`]
44//! * [`assert_lt`]
45//!
46//! ### Matching
47//!
48//! * [`assert_matches`]
49//!
50//! ### `Result` macros
51//!
52//! Assertions for [`Result`] variants:
53//!
54//! * [`assert_ok`]
55//! * [`assert_err`]
56//! * [`assert_ok_eq`]
57//!
58//! ### `Option` macros
59//!
60//! Assertions for [`Option`] variants:
61//!
62//! * [`assert_some`]
63//! * [`assert_none`]
64//! * [`assert_some_eq`]
65//!
66//! ### `Poll` macros
67//!
68//! Assertions for [`Poll`] variants:
69//!
70//! * [`assert_ready`]
71//! * [`assert_ready_ok`]
72//! * [`assert_ready_err`]
73//! * [`assert_ready_pending`]
74//! * [`assert_ready_eq`]
75//!
76//! [`core`]: https://doc.rust-lang.org/stable/core/#macros
77//! [`std`]: https://doc.rust-lang.org/stable/std/#macros
78//! [`Option`]: https://doc.rust-lang.org/core/option/enum.Option.html
79//! [`Result`]: https://doc.rust-lang.org/core/result/enum.Result.html
80//! [`Poll`]: https://doc.rust-lang.org/core/task/enum.Poll.html
81//! [`assert_eq`]: https://doc.rust-lang.org/std/macro.assert_eq.html
82//! [`assert_ne`]: https://doc.rust-lang.org/std/macro.assert_ne.html
83//! [`assert_ge`]: ./macro.assert_ge.html
84//! [`assert_gt`]: ./macro.assert_gt.html
85//! [`assert_le`]: ./macro.assert_le.html
86//! [`assert_lt`]: ./macro.assert_lt.html
87//! [`assert_some`]: ./macro.assert_some.html
88//! [`assert_none`]: ./macro.assert_none.html
89//! [`assert_some_eq`]: ./macro.assert_some_eq.html
90//! [`assert_ok`]: ./macro.assert_ok.html
91//! [`assert_err`]: ./macro.assert_err.html
92//! [`assert_ok_eq`]: ./macro.assert_ok_eq.html
93//! [`assert_ready`]: ./macro.assert_ready.html
94//! [`assert_ready_ok`]: ./macro.assert_ready_ok.html
95//! [`assert_ready_err`]: ./macro.assert_ready_err.html
96//! [`assert_ready_pending`]: ./macro.assert_ready_pending.html
97//! [`assert_ready_eq`]: ./macro.assert_ready_eq.html
98//! [`assert_matches`]: ./macro.assert_matches.html
99
100mod assert_err;
101mod assert_ge;
102mod assert_gt;
103mod assert_le;
104mod assert_lt;
105mod assert_none;
106mod assert_ok;
107mod assert_ok_eq;
108mod assert_some;
109mod assert_some_eq;
110
111#[cfg(has_task_poll)]
112mod assert_pending;
113#[cfg(has_task_poll)]
114mod assert_ready;
115#[cfg(has_task_poll)]
116mod assert_ready_eq;
117#[cfg(has_task_poll)]
118mod assert_ready_err;
119#[cfg(has_task_poll)]
120mod assert_ready_ok;
121
122#[cfg(rustc_1_26)]
123mod assert_matches;