diff --git a/src/lib.rs b/src/lib.rs index 558d877..26e61a8 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -4,6 +4,23 @@ pub extern crate core as _core; /// Asserts at compile-time that the two types have equal sizes. +/// +/// # Example +/// +/// ``` +/// #[macro_use] +/// extern crate static_assertions; +/// +/// struct Byte(u8); +/// +/// fn main() { +/// assert_eq_size!(Byte, u8); +/// // assert_eq_size!(Byte, u16); // Fails to compile +/// +/// // Supports unlimited arguments: +/// assert_eq_size!([Byte; 4], [u16; 2], u32); +/// } +/// ``` #[macro_export] macro_rules! assert_eq_size { ($x:ty, $y:ty) => {