nodiscard.h File Reference

(892c46283a5ea4179500d951c9d4866c0051f27b)

Defines RBIMPL_ATTR_NODISCARD. More...

#include "ruby/internal/has/attribute.h"
#include "ruby/internal/has/c_attribute.h"
#include "ruby/internal/has/cpp_attribute.h"

Include dependency graph for nodiscard.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros
#define	RBIMPL_ATTR_NODISCARD()   __attribute__((__warn_unused_result__))
	Wraps (or simulates) [[nodiscard]]. More...

Detailed Description

Defines RBIMPL_ATTR_NODISCARD.

Author

Ruby developers ruby-.nosp@m.core.nosp@m.@ruby.nosp@m.-lan.nosp@m.g.org

Copyright

This file is a part of the programming language Ruby. Permission is hereby granted, to either redistribute and/or modify this file, provided that the conditions mentioned in the file COPYING are met. Consult the file for details.

Warning

Symbols prefixed with either RBIMPL or rbimpl are implementation details. Don't take them as canon. They could rapidly appear then vanish. The name (path) of this header file is also an implementation detail. Do not expect it to persist at the place it is now. Developers are free to move it anywhere anytime at will.

Note

To ruby-core: remember that this header can be possibly recursively included from extension libraries written in C++. Do not expect for instance __VA_ARGS__ is always available. We assume C99 for ruby itself but we don't assume languages of extension libraries. They could be written in C++98.

Definition in file nodiscard.h.

Macro Definition Documentation

RBIMPL_ATTR_NODISCARD

#define RBIMPL_ATTR_NODISCARD

(

)

__attribute__((__warn_unused_result__))

Wraps (or simulates) [[nodiscard]].

In C++ (at least since C++20) a nodiscard attribute can have a message why the result shall not be ignored. However GCC attribute and SAL annotation cannot take them.

Definition at line 37 of file nodiscard.h.