Namespaces
Variants

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

From cppreference.net
C++ language
General topics
Flow control
Conditional execution statements
Iteration statements (loops)
Jump statements
Functions
Function declaration
Lambda function expression
inline specifier
Dynamic exception specifications ( until C++17* )
noexcept specifier (C++11)
Exceptions
Namespaces
Types
Specifiers
constexpr (C++11)
consteval (C++20)
constinit (C++20)
Storage duration specifiers
Initialization
Expressions
Alternative representations
Literals
Boolean - Integer - Floating-point
Character - String - nullptr (C++11)
User-defined (C++11)
Utilities
Attributes (C++11)
Types
typedef declaration
Type alias declaration (C++11)
Casts
Memory allocation
Classes
Class-specific function properties
Special member functions
Templates
Miscellaneous

Si una función declarada nodiscard o una función que retorna una enumeración o clase declarada nodiscard por valor es llamada desde una expresión de valor descartado que no sea una conversión a void , se recomienda al compilador que emita una advertencia.

Contenidos

Sintaxis

[ [ nodiscard ] ] (1) (desde C++17)
[ [ nodiscard ( literal-de-cadena ) ] ] (2) (desde C++20)
string-literal - un literal de cadena no evaluado que podría utilizarse para explicar la razón por la cual el resultado no debería descartarse

Explicación

Aparece en una declaración de función, declaración de enumeración o declaración de clase.

Si, desde una expresión de valor descartado que no sea un cast a void ,

se recomienda al compilador que emita una advertencia.

El string-literal , si se especifica, normalmente se incluye en las advertencias.

(since C++20)

Ejemplo

struct [[nodiscard]] error_info { /*...*/ };
error_info enable_missile_safety_mode() { /*...*/ return {}; }
void launch_missiles() { /*...*/ }
void test_missiles()
{
    enable_missile_safety_mode(); // el compilador puede advertir al descartar un valor nodiscard
    launch_missiles();
}
error_info& foo() { static error_info e; /*...*/ return e; }
void f1() { foo(); } // el tipo nodiscard no se retorna por valor, sin advertencia
// nodiscard( cadena-de-caracteres ) (desde C++20):
[[nodiscard("PURE FUN")]] int strategic_value(int x, int y) { return x ^ y; }
int main()
{
    strategic_value(4, 2); // el compilador puede advertir al descartar un valor nodiscard
    auto z = strategic_value(0, 0); // OK: el valor de retorno no se descarta
    return z;
}

Salida posible:

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

Biblioteca estándar

Las siguientes funciones estándar se declaran con el atributo nodiscard :

Contenido extendido
Funciones de asignación
funciones de asignación
(función)
asigna almacenamiento no inicializado
(función miembro pública de std::allocator<T> )
[static]
asigna almacenamiento no inicializado usando el asignador
(función miembro pública estática de std::allocator_traits<Alloc> )
asigna memoria
(función miembro pública de std::pmr::memory_resource )
asignar memoria
(función miembro pública de std::pmr::polymorphic_allocator<T> )
asigna almacenamiento no inicializado usando el asignador externo
(función miembro pública de std::scoped_allocator_adaptor<OuterAlloc,InnerAlloc...> )
Acceso indirecto
(C++17)
barrera de optimización de punteros
(plantilla de función)
informa al compilador que un puntero está alineado
(plantilla de función)
Funciones de verificación de vacío
(C++17)
comprueba si el contenedor está vacío
(plantilla de función)
verifica si el manejador de nodo está vacío
(función miembro pública de node handle )
verifica si el contenedor está vacío
(función miembro pública de std::array<T,N> )
verifica si la cadena está vacía
(función miembro pública de std::basic_string<CharT,Traits,Allocator> )
verifica si la vista está vacía
(función miembro pública de std::basic_string_view<CharT,Traits> )
verifica si el contenedor está vacío
(función miembro pública de std::deque<T,Allocator> )
verifica si el contenedor está vacío
(función miembro pública de std::forward_list<T,Allocator> )
verifica si el contenedor está vacío
(función miembro pública de std::list<T,Allocator> )
verifica si el contenedor está vacío
(función miembro pública de std::map<Key,T,Compare,Allocator> )
verifica si la coincidencia fue exitosa
(función miembro pública de std::match_results<BidirIt,Alloc> )
verifica si el contenedor está vacío
(función miembro pública de std::multimap<Key,T,Compare,Allocator> )
verifica si el contenedor está vacío
(función miembro pública de std::multiset<Key,Compare,Allocator> )
verifica si el adaptador de contenedor está vacío
(función miembro pública de std::priority_queue<T,Container,Compare> )
verifica si el adaptador de contenedor está vacío
(función miembro pública de std::queue<T,Container> )
verifica si el contenedor está vacío
(función miembro pública de std::set<Key,Compare,Allocator> )
verifica si la secuencia está vacía
(función miembro pública de std::span<T,Extent> )
verifica si el adaptador de contenedor está vacío
(función miembro pública de std::stack<T,Container> )
verifica si el contenedor está vacío
(función miembro pública de std::unordered_map<Key,T,Hash,KeyEqual,Allocator> )
verifica si el contenedor está vacío
(función miembro pública de std::unordered_multimap<Key,T,Hash,KeyEqual,Allocator> )
verifica si el contenedor está vacío
(función miembro pública de std::unordered_multiset<Key,Hash,KeyEqual,Allocator> )
verifica si el contenedor está vacío
(función miembro pública de std::unordered_set<Key,Hash,KeyEqual,Allocator> )
verifica si el contenedor está vacío
(función miembro pública de std::vector<T,Allocator> )
verifica si la ruta está vacía
(función miembro pública de std::filesystem::path )
Miscelánea
(C++11)
ejecuta una función de forma asincrónica (potencialmente en un nuevo hilo) y devuelve un std::future que contendrá el resultado
(plantilla de función)
(hasta C++26)

Informes de defectos

Los siguientes informes de defectos que modifican el comportamiento se aplicaron retroactivamente a los estándares de C++ publicados anteriormente.

DR Aplicado a Comportamiento publicado Comportamiento correcto
P1771R1 C++17 [[nodiscard]] en constructores no tiene efecto puede generar una advertencia si el objeto construido es descartado

Referencias

  • Estándar C++23 (ISO/IEC 14882:2024):
  • 9.12.9 Atributo Nodiscard [dcl.attr.nodiscard]
  • Estándar C++20 (ISO/IEC 14882:2020):
  • 9.12.8 Atributo Nodiscard [dcl.attr.nodiscard]
  • Estándar C++17 (ISO/IEC 14882:2017):
  • 10.6.7 Atributo Nodiscard [dcl.attr.nodiscard]

Véase también

(C++11)
marcador de posición para omitir un elemento al desempaquetar una tuple usando tie
(constante)
Documentación de C para nodiscard