CoreComponents 3.0.0
A Modern C++ Toolkit
Loading...
Searching...
No Matches
KeyValue< K, V > Class Template Reference

Key-value pair. More...

#include <cc/KeyValue>

Public Types

using Key = K
 key type
 
using Value = V
 value type
 

Public Member Functions

 KeyValue ()
 Create an undefined key-value pair.
 
 KeyValue (const Key &key)
 Create a search key.
 
 KeyValue (const Key &key, const Value &value)
 Create a defined key-value pair.
 
 KeyValue (const Key &&key, const Value &&value)
 
const Keykey () const
 Get key.
 
const Valuevalue () const
 Get value.
 
Valuevalue ()
 Get mutable value.
 
void setValue (const Value &newValue)
 Set new value
 
bool operator== (const KeyValue &other) const
 Comparism operators.
 
template<class Pattern >
bool operator== (const Pattern &pattern) const
 Equality operator.
 
std::strong_ordering operator<=> (const KeyValue &other) const
 Ordering operator.
 
template<class Pattern >
std::strong_ordering operator<=> (const Pattern &pattern) const
 Ordering operator.
 

Detailed Description

template<class K, class V = K>
class cc::KeyValue< K, V >

Key-value pair.

Member Typedef Documentation

◆ Key

template<class K , class V = K>
using Key = K

key type

◆ Value

template<class K , class V = K>
using Value = V

value type

Constructor & Destructor Documentation

◆ KeyValue() [1/3]

template<class K , class V = K>
KeyValue ( )

Create an undefined key-value pair.

◆ KeyValue() [2/3]

template<class K , class V = K>
KeyValue ( const Key & key)

Create a search key.

◆ KeyValue() [3/3]

template<class K , class V = K>
KeyValue ( const Key & key,
const Value & value )

Create a defined key-value pair.

Member Function Documentation

◆ key()

template<class K , class V = K>
const Key & key ( ) const

Get key.

◆ value() [1/2]

template<class K , class V = K>
const Value & value ( ) const

Get value.

◆ value() [2/2]

template<class K , class V = K>
Value & value ( )

Get mutable value.

◆ setValue()

template<class K , class V = K>
void setValue ( const Value & newValue)

Set new value

◆ operator==() [1/2]

template<class K , class V = K>
bool operator== ( const KeyValue< K, V > & other) const

Comparism operators.

Equality operator

◆ operator==() [2/2]

template<class K , class V = K>
template<class Pattern >
bool operator== ( const Pattern & pattern) const

Equality operator.

◆ operator<=>() [1/2]

template<class K , class V = K>
std::strong_ordering operator<=> ( const KeyValue< K, V > & other) const

Ordering operator.

◆ operator<=>() [2/2]

template<class K , class V = K>
template<class Pattern >
std::strong_ordering operator<=> ( const Pattern & pattern) const

Ordering operator.