static_assert 声明

 

C++

编译器支持

自立实现与有宿主实现

语言

标准库

标准库标头

具名要求

功能特性测试宏 (C++20)

语言支持库

概念库 (C++20)

元编程库 (C++11)

诊断库

通用工具库

字符串库

容器库

迭代器库

范围库 (C++20)

算法库

数值库

本地化库

输入/输出库

文件系统库 (C++17)

正则表达式库 (C++11)

并发支持库 (C++11)

技术规范

符号索引

外部库

 

C++ 语言

 

声明

概览 声明语法 声明说明符序列 声明符 说明符 typedef inline virtual 函数说明符 explicit 函数说明符 friend constexpr (C++11) consteval (C++20) constinit (C++20) 存储类说明符 翻译单元局部 (C++20) classstruct union enum decltype (C++11) auto (C++11) alignas (C++11) constvolatile 详述类型说明符 属性(C++11)

声明符 引用 指针 数组 块声明 简单声明 结构化绑定声明 (C++17) 别名声明(C++11) 命名空间别名定义 using 声明 using 指令 static_assert 声明 (C++11) asm 声明 不可见 enum 声明(C++11) 其他声明 命名空间定义 函数声明 类模板声明 函数模板声明 显式模板实例化(C++11) 显式模板特化 链接说明 属性声明 (C++11) 空声明

 

进行编译时断言检查。

语法

static_assert( 布尔常量表达式 , 消息 )		(C++11 起)
static_assert( 布尔常量表达式 )		(C++17 起)

解释

布尔常量表达式	-	按语境转换到 bool 类型的常量表达式。不允许进行内置转换，除了到 bool 的非窄化整数转换。 (C++23 前) 按语境转换到 bool 类型的表达式，其中转换是常量表达式。 (C++23 起)
消息	-	当布尔常量表达式为 false 时作为编译器错误信息的 无编码前缀的不求值字符串字面量 或者 常量表达式 msg，满足 msg.size() 可以隐式转换为 std::size_t msg.data() 可以隐式转换为 const char* (C++26 起)

static_assert 声明可以出现在命名空间和块作用域中（作为块声明），也可以在类体中（作为成员声明）。

如果 布尔常量表达式 良构并求值为 true，或在模板定义的语境中求值而该模板未被实例化，那么该声明没有效果。否则将发出编译时错误，且当存在 消息 时诊断消息中会包含它。

如果消息不是字符串字面量，它仅在布尔常量表达式为 false 时求值。消息文本由字符序列 [msg.data(), msg.data() + msg.size()) 组成，该字符序列必须表示有效范围，并且序列中的每个元素都必须是整数常量表达式。

(C++26 起)

注解

标准并不要求编译器打印信息的每一个字，不过编译器一般会尽可能打印。

因为消息 必须是字符串字面量，所以它不能容纳动态信息，乃至自身并非字符串字面量的常量表达式。特别是它不能容纳模板类型实参的名字。

(C++26 前)

功能特性测试宏	值	标准	注释
__cpp_static_assert	200410L	(C++11)	static_assert(布尔常量表达式 , "消息")
	201411L	(C++17)	单参数 static_assert(布尔常量表达式 )
	202306L	(C++26)	用户生成的 static_assert 消息

示例

运行此代码

#include <format>
#include <type_traits>
 
static_assert(03301 == 1729); // C++17 起可省略消息
 
template <class T>
void swap(T& a, T& b) noexcept
{
    static_assert(std::is_copy_constructible<T>::value,
                  "交换需要可复制");
    static_assert(std::is_nothrow_copy_constructible<T>::value
               && std::is_nothrow_copy_assignable<T>::value,
                  "交换需要可复制及可赋值，且无异常抛出");
    auto c = b;
    b = a;
    a = c;
}
 
template<class T>
struct data_structure
{
    static_assert(std::is_default_constructible<T>::value,
                  "数据结构要求元素可默认构造");
};
 
template<class>
constexpr bool dependent_false = false; // CWG2518/P2593R1 前的变通方法
 
template<class T>
struct bad_type
{
    static_assert(dependent_false<T>, "实例化时错误，变通方法");
    static_assert(false, "实例化时错误"); // 由于 CWG2518/P2593R1 OK
};
 
struct no_copy
{
    no_copy(const no_copy&) = delete;
    no_copy() = default;
};
 
struct no_default
{
    no_default() = delete;
};
 
#if __cpp_static_assert >= 202306L
// C++ 目前还不能真正使下面这句工作（需要 std::format 为 constexpr）：
static_assert(sizeof(long) == 4, std::format("期待 4，得到 {}", sizeof(long)));
#endif
 
int main()
{
    int a, b;
    swap(a, b);
 
    no_copy nc_a, nc_b;
    swap(nc_a, nc_b); // 1
 
    [[maybe_unused]] data_structure<int> ds_ok;
    [[maybe_unused]] data_structure<no_default> ds_error; // 2
}

可能的输出：

1：错误：静态断言失败：交换需要可复制
2：错误：静态断言失败：数据结构要求元素可默认构造
3：错误：静态断言失败：期待 4，得到 8

缺陷报告

下列更改行为的缺陷报告追溯地应用于以前出版的 C++ 标准。

缺陷报告	应用于	出版时的行为	正确行为
CWG 2039	C++11	只要求转换前的表达式是常量	转换本身必须也在常量表达式中合法
CWG 2518	C++11	未实例化的 static_assert(false, ""); 会导致错误	使之良构

参阅

#error	显示给定的错误信息并使程序非良构 (预处理指令)
assert	若用户指定的条件非 true 则中断程序。可以在发行构建中禁用 (宏函数)
enable_if (C++11)	条件性地从重载决议移除函数重载或模板特化 (类模板)
类型特征 (C++11)	定义了一个编译期基于模板的用来查询或修改类型性质的接口