Namensräume
Varianten
Aktionen

C-Attribut: nodiscard (seit C23)

Von cppreference.com
< c‎ | Sprache‎ | Attribute

Wenn eine Funktion, die mit nodiscard deklariert wurde, oder eine Funktion, die eine Struktur/Union/Aufzählung mit nodiscard nach Wert zurückgibt, in einem Discarded-Value-Ausdruck außer einem Cast nach void aufgerufen wird, wird dem Compiler empfohlen, eine Warnung auszugeben.

Inhalt

[bearbeiten] Syntax

[[ nodiscard ]]
[[ __nodiscard__ ]]
(1)
[[ nodiscard ( string-literal ) ]]
[[ __nodiscard__ ( string-literal ) ]]
(2)
string-literal - Text, der verwendet werden könnte, um die Begründung zu erklären, warum das Ergebnis nicht verworfen werden sollte

[bearbeiten] Erklärung

Erscheint in einer Funktionsdeklaration, Aufzählungsdeklaration oder Struktur/Union-Deklaration.

Wenn von einem Discarded-Value-Ausdruck außer einem Cast nach void,

  • eine mit nodiscard deklarierte Funktion aufgerufen wird, oder
  • eine Funktion aufgerufen wird, die eine mit nodiscard deklarierte Struktur/Union/Aufzählung nach Wert zurückgibt,

wird dem Compiler empfohlen, eine Warnung auszugeben.

Der string-literal, falls angegeben, wird normalerweise in den Warnungen enthalten sein.

[bearbeiten] Beispiel

struct [[nodiscard]] error_info { int status; /*...*/ };
struct error_info enable_missile_safety_mode() { /*...*/ return (struct error_info){0}; }
void launch_missiles() { /*...*/ }
void test_missiles() {
   enable_missile_safety_mode(); // compiler may warn on discarding a nodiscard value
   launch_missiles();
}
struct error_info* foo() { static struct error_info e; /*...*/ return &e; }
void f1() {
    foo(); // nodiscard type itself is not returned, no warning
}
// nodiscard( string-literal ):
[[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
    int z = strategic_value(0,0); // OK: return value is not discarded
    return z;
}

Mögliche Ausgabe

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

[bearbeiten] Siehe auch

C++-Dokumentation für nodiscard