C++ attribute: nodiscard (since C++17)

From cppreference.net

Если функция, объявленная с nodiscard , или функция, возвращающая перечисление или класс, объявленный nodiscard по значению, вызывается из выражения отбрасываемого значения , отличного от приведения к void , компилятору рекомендуется выдавать предупреждение.

Содержание

Синтаксис


`[ [ nodiscard ] ]`	(1)	(начиная с C++17)

`[ [ nodiscard (` строковый литерал `) ] ]`	(2)	(начиная с C++20)

string-literal

an unevaluated string literal that could be used to explain the rationale for why the result should not be discarded

Объяснение

Появляется в объявлении функции, объявлении перечисления или объявлении класса.

Если из discarded-value expression , отличного от приведения к void ,

вызывается функция, объявленная с nodiscard , или
вызывается функция, возвращающая перечисление или класс, объявленный с nodiscard по значению, или
конструктор, объявленный с nodiscard , вызывается через явное преобразование типа или static_cast , или
объект типа перечисления или класса, объявленного с nodiscard , инициализируется через явное преобразование типа или static_cast ,

компилятору рекомендуется выдать предупреждение.

Строковый литерал string-literal , если указан, обычно включается в предупреждения.

(since C++20)

Пример

Запустить этот код

struct [[nodiscard]] error_info { /*...*/ };
error_info enable_missile_safety_mode() { /*...*/ return {}; }
void launch_missiles() { /*...*/ }
void test_missiles()
{
    enable_missile_safety_mode(); // компилятор может предупредить об отбрасывании nodiscard значения
    launch_missiles();
}
error_info& foo() { static error_info e; /*...*/ return e; }
void f1() { foo(); } // nodiscard тип не возвращается по значению, предупреждения нет
// nodiscard( строковый литерал ) (начиная с C++20):
[[nodiscard("PURE FUN")]] int strategic_value(int x, int y) { return x ^ y; }
int main()
{
    strategic_value(4, 2); // компилятор может предупредить об отбрасывании nodiscard значения
    auto z = strategic_value(0, 0); // OK: возвращаемое значение не отбрасывается
    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 new operator new[]	функции выделения памяти (функция)
allocate	выделяет неинициализированную память (публичная функция-член `std::allocator<T>` )
allocate [static]	выделяет неинициализированную память с использованием аллокатора (публичная статическая функция-член `std::allocator_traits<Alloc>` )
allocate	выделяет память (публичная функция-член `std::pmr::memory_resource` )
allocate	выделить память (публичная функция-член `std::pmr::polymorphic_allocator<T>` )
allocate	выделяет неинициализированную память с использованием внешнего аллокатора (публичная функция-член `std::scoped_allocator_adaptor<OuterAlloc,InnerAlloc...>` )
Косвенный доступ
launder (C++17)	барьер оптимизации указателей (шаблон функции)
assume_aligned (C++20)	информирует компилятор, что указатель выровнен (шаблон функции)
Функции проверки на пустоту
empty (C++17)	проверяет, является ли контейнер пустым (шаблон функции)
empty	проверяет, является ли node handle пустым (публичная функция-член `node handle` )
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)	заполнитель для пропуска элемента при распаковке `tuple` с использованием `tie` (константа)
документация C для nodiscard

Compiler support
Freestanding and hosted
Language
Standard library
Standard library headers
Named requirements
Feature test macros (C++20)
Language support library
Concepts library (C++20)
Diagnostics library
Memory management library
Metaprogramming library (C++11)
General utilities library
Containers library
Iterators library
Ranges library (C++20)
Algorithms library
Strings library
Text processing library
Numerics library
Date and time library
Input/output library
Filesystem library (C++17)
Concurrency support library (C++11)
Execution control library (C++26)
Technical specifications
Symbols index
External libraries

assume (C++23)
carries_dependency (C++11) (until C++26)
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.net

Namespaces

Variants

C++ attribute: nodiscard (since C++17)

Содержание

Синтаксис

Объяснение

Пример

Стандартная библиотека

Функции выделения памяти

Косвенный доступ

Функции проверки на пустоту

Разное

Отчеты о дефектах

Ссылки

Смотрите также