Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve examples in docs and README #14

Merged
merged 1 commit into from
Apr 26, 2022
Merged

Improve examples in docs and README #14

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,9 +32,9 @@ Then make compile time assertions like:
use core::num::NonZeroU8;

qed::const_assert!(usize::BITS >= u32::BITS);
qed::const_assert_eq!("Veni, vidi, vici".len(), "Cogito, ergo sum".len());
qed::const_assert_ne!('∎'.len_utf8(), 0);
qed::const_assert_matches!(NonZeroU8::new(42), Some(_));
qed::const_assert_eq!("Veni, vidi, vici".len(), 16);
qed::const_assert_ne!('∎'.len_utf8(), 1);
qed::const_assert_matches!(NonZeroU8::new(42), Some(nz) if nz.get() == 42);
```

## `no_std`
Expand Down
16 changes: 9 additions & 7 deletions src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,9 +30,9 @@
//! # use core::num::NonZeroU8;
//! # #[cfg(any(target_pointer_width = "32", target_pointer_width = "64"))]
//! qed::const_assert!(usize::BITS >= u32::BITS);
//! qed::const_assert_eq!("Veni, vidi, vici".len(), "Cogito, ergo sum".len());
//! qed::const_assert_ne!('∎'.len_utf8(), 0);
//! qed::const_assert_matches!(NonZeroU8::new(42), Some(_));
//! qed::const_assert_eq!("Veni, vidi, vici".len(), 16);
//! qed::const_assert_ne!('∎'.len_utf8(), 1);
//! qed::const_assert_matches!(NonZeroU8::new(42), Some(nz) if nz.get() == 42);
//! ```
//!
//!
Expand Down Expand Up @@ -108,13 +108,13 @@ macro_rules! const_assert {
/// # Examples
///
/// ```
/// qed::const_assert_eq!("Veni, vidi, vici".len(), "Cogito, ergo sum".len());
/// qed::const_assert_eq!("Veni, vidi, vici".len(), 16);
/// ```
///
/// The following fails to compile because the expressions are not equal:
///
/// ```compile_fail
/// qed::const_assert_eq!("Carpe diem".len(), "Et tu, Brute?".len());
/// qed::const_assert_eq!("Carpe diem".len(), 100);
/// ```
#[macro_export]
macro_rules! const_assert_eq {
Expand All @@ -132,7 +132,7 @@ macro_rules! const_assert_eq {
///
/// ```
/// const END_OF_PROOF: char = '∎';
/// qed::const_assert_ne!(END_OF_PROOF.len_utf8(), 0);
/// qed::const_assert_ne!(END_OF_PROOF.len_utf8(), 1);
/// ```
///
/// The following fails to compile because the expressions are equal:
Expand Down Expand Up @@ -161,7 +161,8 @@ macro_rules! const_assert_ne {
/// ```
/// # use core::num::NonZeroU8;
/// qed::const_assert_matches!(NonZeroU8::new(0), None);
/// qed::const_assert_matches!(NonZeroU8::new(42), Some(_));
/// qed::const_assert_matches!(NonZeroU8::new(29), Some(_));
/// qed::const_assert_matches!(NonZeroU8::new(42), Some(nz) if nz.get() == 42);
/// ```
///
/// Assertion failures will result in a compile error:
Expand Down Expand Up @@ -442,6 +443,7 @@ mod tests {
#[test]
fn const_assert_matches_no_warnings() {
crate::const_assert_matches!(NonZeroU8::new(0), None);
crate::const_assert_matches!(NonZeroU8::new(29), Some(_));
crate::const_assert_matches!(NonZeroU8::new(29), Some(x) if x.get() == 29);
}

Expand Down