qed

Crates.ioqed
lib.rsqed
version1.6.1
sourcesrc
created_at2022-04-08 05:12:25.867865
updated_at2023-06-02 17:52:02.423353
descriptionCompile-time assertions
homepagehttps://github.com/artichoke/qed
repositoryhttps://github.com/artichoke/qed
max_upload_size
id564037
size24,441
crates.io publishers (github:artichoke:crates-io-publishers)

documentation

https://docs.rs/qed

README

qed

GitHub Actions Discord Twitter
Crate API API trunk

Compile time assertions.

QED is an initialism of the Latin phrase quod erat demonstrandum, meaning "which was to be demonstrated".

This crate contains compile time assertion macros used for maintaining safety invariants or limiting platform support. If the assertion is false, a compiler error is emitted.

Usage

Add this to your Cargo.toml:

[dependencies]
qed = "1.6.1"

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(), 16);
qed::const_assert_ne!('∎'.len_utf8(), 1);
qed::const_assert_matches!(NonZeroU8::new(42), Some(nz) if nz.get() == 42);

no_std

qed is no_std compatible and all macros only require core.

Minimum Supported Rust Version

This crate requires at least Rust 1.64.0. This version can be bumped in minor releases.

License

qed is licensed under the MIT License (c) Ryan Lopopolo.

Commit count: 161

cargo fmt