C++ concepts: NullablePointer (since C++11)

 

C++

Language

Standard library headers

Concepts

Utilities library

Strings library

Containers library

Algorithms library

Iterators library

Numerics library

Input/output library

Localizations library

Regular expressions library (C++11)

Atomic operations library (C++11)

Thread support library (C++11)

Filesystem library (C++17)

Technical Specifications

 

C++ concepts

Basic
DefaultConstructible CopyAssignable CopyConstructible	MoveAssignable (C++11) MoveConstructible (C++11) Destructible
Layout
TrivialType (C++11) TriviallyCopyable (C++11)	StandardLayoutType (C++11) PODType
Library-Wide
EqualityComparable LessThanComparable Swappable (C++11) ValueSwappable (C++11)	NullablePointer (C++11) Hash (C++11) Allocator
Container
Container SequenceContainer ContiguousContainer (C++17) ReversibleContainer	AssociativeContainer AllocatorAwareContainer UnorderedAssociativeContainer (C++11)
Container Elements
DefaultInsertable (C++11) CopyInsertable (C++11) MoveInsertable (C++11)	EmplaceConstructible (C++11) Erasable (C++11)
Iterator
Iterator OutputIterator InputIterator	ForwardIterator BidirectionalIterator RandomAccessIterator ContiguousIterator (C++17)
Stream I/O
FormattedInputFunction UnformattedInputFunction	FormattedOutputFunction UnformattedOutputFunction
Random Numbers
SeedSequence (C++11) RandomNumberEngine (C++11)	RandomNumberDistribution (C++11) UniformRandomNumberGenerator (C++11) RandomNumberEngineAdaptor (C++11)
Concurrency
BasicLockable (C++11) Lockable (C++11) TimedLockable (C++11)	Mutex (C++11) TimedMutex (C++11) SharedMutex (C++17) SharedTimedMutex (C++14)
Other
CharTraits pos_type off_type Clock (C++11) BitmaskType	UnaryTypeTrait (C++11) BinaryTypeTrait (C++11) TransformationTrait (C++11) TrivialClock (C++11) LiteralType (C++11)

 

Specifies that the type is a pointer-like object which can be compared to std::nullptr_t objects.

Requirements

The type must meet all of the following concept requirements:

• EqualityComparable
• DefaultConstructible
• CopyConstructible
• CopyAssignable
• Destructible

In addition, a value-initialized object of the type must produce a null value of that type. This null value shall only be equivalent to itself. Default initialization of the type may have an indeterminate value.

An object of the type must be contextually convertible to bool. The effect of this conversion returns false if the value is equivalent to its null value and true otherwise.

None of the operations that this type performs may throw exceptions.

The type must satisfy the following additional expressions, given two values p and q that are of the type, and that np is a value of std::nullptr_t type (possibly const qualified):

Expression	Effects
Type p(np); Type p = np;	Afterwards, p is equivalent to nullptr
Type(np)	a temporary object that is equivalent to nullptr
p = np	Must return a Type&, and afterwards, p is equivalent to nullptr
p != q	Must return a value that is contextually convertible to bool. The effect is !(p == q)
p == np np == p	Must return a value that is contextually convertible to bool. The effect is (p == Type())
p != np np != p	Must return a value that is contextually convertible to bool. The effect is !(p == np)

Notes

Note that dereferencing (operator* or operator->) is not required of a NullablePointer type. A minimalistic type that satisfies these requirements is

class handle {
    int id;
  public:
    handle(std::nullptr_t = nullptr) : id(0) { }
    explicit operator bool() { return id != 0; }
    friend bool operator ==(handle l, handle r) { return l.id == r.id; }
    friend bool operator !=(handle l, handle r) { return !(l == r); }
};

Standard library

The following types must satisfy NullablePointer:

• The member types X::pointer, X::const_pointer, X::void_pointer and X::const_void_pointer of every Allocator type X
• The member type X::pointer of std::unique_ptr
• The type std::exception_ptr