C++ 属性： nodiscard (自 C++17 起)

如果一个声明为 nodiscard 的函数，或一个返回值为枚举或类（按值声明为 nodiscard）的函数从一个丢弃值表达式（非强制转换为 void）调用，则编译器鼓励发出警告。

内容

1 语法
2 说明
3 示例
4 标准库
5 缺陷报告
6 参考资料
7 另请参阅

[编辑] 语法


`[[nodiscard]]`	(1)	(自 C++17 起)

`[[nodiscard(` 字符串字面量 `)]]`	(2)	(自 C++20 起)

字符串字面量

-

一个未计算的字符串字面量，可用于解释为什么结果不应被丢弃

[编辑] 说明

出现在函数声明、枚举声明或类声明中。

如果，从一个丢弃值表达式（非强制转换为 void），

调用一个声明为 nodiscard 的函数，或
调用一个返回值为枚举或类（按值声明为 nodiscard）的函数，或
通过显式类型转换或 static_cast 调用一个声明为 nodiscard 的构造函数，或
通过显式类型转换或 static_cast 初始化一个声明为 nodiscard 的枚举或类类型的对象，

则编译器鼓励发出警告。

如果指定了，字符串文字通常会包含在警告中。

(自 C++20 起)

[编辑] 示例

运行此代码

struct [[nodiscard]] error_info { /*...*/ };
 
error_info enable_missile_safety_mode() { /*...*/ return {}; }
 
void launch_missiles() { /*...*/ }
 
void test_missiles()
{
    enable_missile_safety_mode(); // compiler may warn on discarding a nodiscard value
    launch_missiles();
}
 
error_info& foo() { static error_info e; /*...*/ return e; }
 
void f1() { foo(); } // nodiscard type is not returned by value, no warning
 
// nodiscard( string-literal ) (since C++20):
[[nodiscard("PURE FUN")]] int strategic_value(int x, int y) { return x ^ y; }
 
int main()
{
    strategic_value(4, 2); // compiler may warn on discarding a nodiscard value
    auto z = strategic_value(0, 0); // OK: return value is not discarded
    return z;
}

可能的输出

game.cpp:5:4: warning: ignoring return value of function declared with ⮠
 'nodiscard' attribute
game.cpp:17:5: warning: ignoring return value of function declared with ⮠
 'nodiscard' attribute: PURE FUN

标准库

以下标准函数声明了 nodiscard 属性

扩展内容

分配函数
operator newoperator new[]	分配函数 (函数) [编辑]
分配	分配未初始化的存储空间 (`std::allocator<T>` 的公共成员函数) [编辑]
分配 [静态]	使用分配器分配未初始化的存储空间 (`std::allocator_traits<Alloc>` 的公共静态成员函数) [编辑]
分配	分配内存 (`std::pmr::memory_resource` 的公共成员函数) [编辑]
分配	分配内存 (`std::pmr::polymorphic_allocator<T>` 的公共成员函数) [编辑]
分配	使用外部分配器分配未初始化的存储空间 (`std::scoped_allocator_adaptor<OuterAlloc,InnerAlloc...>` 的公共成员函数) [编辑]
间接访问
清洗 (C++17)	指针优化屏障 (函数模板) [编辑]
assume_aligned (C++20)	通知编译器指针已对齐 (函数模板) [编辑]
空值检查函数
empty (C++17)	检查容器是否为空 (函数模板) [编辑]
empty	检查节点句柄是否为空 (`节点句柄` 的公共成员函数)
empty	检查容器是否为空 (`std::array<T,N>` 的公共成员函数) [编辑]
empty	检查字符串是否为空 (`std::basic_string<CharT,Traits,Allocator>` 的公共成员函数) [编辑]
empty	检查视图是否为空 (`std::basic_string_view<CharT,Traits>` 的公共成员函数) [编辑]
empty	检查容器是否为空 (`std::deque<T,Allocator>` 的公共成员函数) [编辑]
empty	检查容器是否为空 (`std::forward_list<T,Allocator>` 的公共成员函数) [编辑]
empty	检查容器是否为空 (`std::list<T,Allocator>` 的公共成员函数) [编辑]
empty	检查容器是否为空 (`std::map<Key,T,Compare,Allocator>` 的公共成员函数) [编辑]
empty	检查匹配是否成功 (`std::match_results<BidirIt,Alloc>` 的公共成员函数) [编辑]
empty	检查容器是否为空 (`std::multimap<Key,T,Compare,Allocator>` 的公共成员函数) [编辑]
empty	检查容器是否为空 (`std::multiset<Key,Compare,Allocator>` 的公共成员函数) [编辑]
empty	检查容器适配器是否为空 (`std::priority_queue<T,Container,Compare>` 的公共成员函数) [编辑]
empty	检查容器适配器是否为空 (`std::queue<T,Container>` 的公共成员函数) [编辑]
empty	检查容器是否为空 (`std::set<Key,Compare,Allocator>` 的公共成员函数) [编辑]
empty	检查序列是否为空 (`std::span<T,Extent>` 的公共成员函数) [编辑]
empty	检查容器适配器是否为空 (`std::stack<T,Container>` 的公共成员函数) [编辑]
empty	检查容器是否为空 (`std::unordered_map<Key,T,Hash,KeyEqual,Allocator>` 的公共成员函数) [编辑]
empty	检查容器是否为空 (`std::unordered_multimap<Key,T,Hash,KeyEqual,Allocator>` 的公共成员函数) [编辑]
empty	检查容器是否为空 (`std::unordered_multiset<Key,Hash,KeyEqual,Allocator>` 的公共成员函数) [编辑]
empty	检查容器是否为空 (`std::unordered_set<Key,Hash,KeyEqual,Allocator>` 的公共成员函数) [编辑]
empty	检查容器是否为空 (`std::vector<T,Allocator>` 的公共成员函数) [编辑]
empty	检查路径是否为空 (`std::filesystem::path` 的公共成员函数) [编辑]
其他
async (C++11)	异步运行函数（可能在新线程中）并返回一个 std::future，该函数将保存结果 (函数模板) [编辑]

(直到 C++26)

[编辑] 缺陷报告

以下行为更改缺陷报告已追溯应用于之前发布的 C++ 标准。

DR	应用于	已发布的行为	正确行为
P1771R1	C++17	`[[nodiscard]]` 对构造函数没有影响	如果构造的对象被丢弃，会导致警告

[编辑] 参考

C++23 标准 (ISO/IEC 14882:2024)

9.12.9 Nodiscard 属性 [dcl.attr.nodiscard]

C++20 标准 (ISO/IEC 14882:2020)

9.12.8 Nodiscard 属性 [dcl.attr.nodiscard]

C++17 标准 (ISO/IEC 14882:2017)

10.6.7 Nodiscard 属性 [dcl.attr.nodiscard]

[编辑] 另请参阅

ignore (C++11)	使用 `tie` 解包 `tuple` 时，用于跳过元素的占位符 (常量) [编辑]
C 文档 for nodiscard

编译器支持
独立和托管
语言
标准库
标准库头文件
命名要求
特性测试宏 (C++20)
语言支持库
概念库 (C++20)
元编程库 (C++11)
诊断库
通用工具库
字符串库
容器库
迭代器库
范围库 (C++20)
算法库
数值库
本地化库
输入/输出库
文件系统库 (C++17)
正则表达式库 (C++11)
并发支持库 (C++11)
执行支持库 (C++26)
技术规范
符号索引
外部库

assume (C++23)
carries_dependency (C++11)
deprecated (C++14)
fallthrough (C++17)
indeterminate (C++26)
likely (C++20)
maybe_unused (C++17)
nodiscard (C++17)
noreturn (C++11)
no_unique_address (C++20)
optimize_for_synchronized (TM TS)
unlikely (C++20)

cppreference.com

命名空间

变体

视图

操作