mirror of
git://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
synced 2025-09-04 20:19:47 +08:00
0fa5f8c877
Add an optional panic message to the `static_assert!` macro. The panic message doesn't support argument formatting, because the `assert!` macro only supports formatting in non-const contexts. Suggested-by: Miguel Ojeda <ojeda@kernel.org> Link: https://github.com/Rust-for-Linux/linux/issues/1149 Signed-off-by: Altan Ozlu <altan@ozlu.eu> Reviewed-by: Benno Lossin <benno.lossin@proton.me> Reviewed-by: Trevor Gross <tmgross@umich.edu> Link: https://lore.kernel.org/r/20250326202520.1176162-2-altan@ozlu.eu Signed-off-by: Miguel Ojeda <ojeda@kernel.org>
40 lines
1.2 KiB
Rust
40 lines
1.2 KiB
Rust
// SPDX-License-Identifier: GPL-2.0
|
|
|
|
//! Static assert.
|
|
|
|
/// Static assert (i.e. compile-time assert).
|
|
///
|
|
/// Similar to C11 [`_Static_assert`] and C++11 [`static_assert`].
|
|
///
|
|
/// An optional panic message can be supplied after the expression.
|
|
/// Currently only a string literal without formatting is supported
|
|
/// due to constness limitations of the [`assert!`] macro.
|
|
///
|
|
/// The feature may be added to Rust in the future: see [RFC 2790].
|
|
///
|
|
/// [`_Static_assert`]: https://en.cppreference.com/w/c/language/_Static_assert
|
|
/// [`static_assert`]: https://en.cppreference.com/w/cpp/language/static_assert
|
|
/// [RFC 2790]: https://github.com/rust-lang/rfcs/issues/2790
|
|
///
|
|
/// # Examples
|
|
///
|
|
/// ```
|
|
/// static_assert!(42 > 24);
|
|
/// static_assert!(core::mem::size_of::<u8>() == 1);
|
|
///
|
|
/// const X: &[u8] = b"bar";
|
|
/// static_assert!(X[1] == b'a');
|
|
///
|
|
/// const fn f(x: i32) -> i32 {
|
|
/// x + 2
|
|
/// }
|
|
/// static_assert!(f(40) == 42);
|
|
/// static_assert!(f(40) == 42, "f(x) must add 2 to the given input.");
|
|
/// ```
|
|
#[macro_export]
|
|
macro_rules! static_assert {
|
|
($condition:expr $(,$arg:literal)?) => {
|
|
const _: () = core::assert!($condition $(,$arg)?);
|
|
};
|
|
}
|