The variant_sequential_view::const_iterator allows iteration over an sequential container in a variant. More...
#include <variant_sequential_view.h>
Public Types | |
using | self_type = const_iterator |
using | value_type = variant |
Public Member Functions | |
const_iterator (const const_iterator &other) | |
Creates a copy of other . | |
~const_iterator () | |
Destroys the variant_sequential_view::const_iterator. | |
const variant | get_data () const |
Returns the current value, stored inside a std::reference_wrapper<T> and copied to a variant. | |
bool | operator!= (const const_iterator &other) const |
Returns true if other points to a different item than this iterator; otherwise returns false. | |
const variant | operator* () const |
Returns the underlying value in a variant stored in a std::reference_wrapper<T> . | |
const_iterator | operator+ (int i) const |
Returns an iterator to the item at i positions forward from this iterator. | |
const_iterator & | operator++ () |
Pre-increment operator advances the iterator to the next item in the container and returns an iterator to the new current item. | |
const_iterator | operator++ (int) |
Post-increment operator advances the iterator to the next item in the container and returns an iterator to the previously current item. | |
const_iterator & | operator+= (int i) |
Advances the iterator by i items. | |
const_iterator | operator- (int i) const |
Returns an iterator to the item at i positions backward from this iterator. | |
const_iterator & | operator-- () |
Pre-decrement operator makes the preceding item current and returns an iterator to the new current item. | |
const_iterator | operator-- (int) |
Post-decrement operator makes the preceding item current and returns an iterator to the previously current item. | |
const_iterator & | operator-= (int i) |
Returns an iterator to the item at i positions backward from this iterator. | |
const_iterator & | operator= (const_iterator other) |
Assigns other to this . | |
bool | operator== (const const_iterator &other) const |
Returns true if other points to the same item as this iterator; otherwise returns false. | |
Detailed Description
The variant_sequential_view::const_iterator allows iteration over an sequential container in a variant.
An instance can only be created by an variant_sequential_view.
Typical Usage
- Remarks
- The iterator is valid as long as the variant_sequential_view and it corresponding variant is valid and not modified.
Member Typedef Documentation
◆ self_type
◆ value_type
Constructor & Destructor Documentation
◆ ~const_iterator()
rttr::variant_sequential_view::const_iterator::~const_iterator | ( | ) |
Destroys the variant_sequential_view::const_iterator.
◆ const_iterator()
rttr::variant_sequential_view::const_iterator::const_iterator | ( | const const_iterator & | other | ) |
Creates a copy of other
.
Member Function Documentation
◆ get_data()
Returns the current value, stored inside a std::reference_wrapper<T>
and copied to a variant.
◆ operator!=()
bool rttr::variant_sequential_view::const_iterator::operator!= | ( | const const_iterator & | other | ) | const |
Returns true if other
points to a different item than this iterator; otherwise returns false.
- See also
- operator==
◆ operator*()
Returns the underlying value in a variant stored in a std::reference_wrapper<T>
.
When the data cannot be returns as reference from the container, the data is stored directly inside the variant. E.g. for std::vector<bool>
no reference can be returned.
◆ operator+()
const_iterator rttr::variant_sequential_view::const_iterator::operator+ | ( | int | i | ) | const |
Returns an iterator to the item at i positions forward from this iterator.
◆ operator++() [1/2]
const_iterator & rttr::variant_sequential_view::const_iterator::operator++ | ( | ) |
Pre-increment operator advances the iterator to the next item in the container and returns an iterator to the new current item.
- Remarks
- Calling this function on and iterator with value variant_sequential_view::end() leads to undefined behaviour.
◆ operator++() [2/2]
const_iterator rttr::variant_sequential_view::const_iterator::operator++ | ( | int | ) |
Post-increment operator advances the iterator to the next item in the container and returns an iterator to the previously current item.
◆ operator+=()
const_iterator & rttr::variant_sequential_view::const_iterator::operator+= | ( | int | i | ) |
Advances the iterator by i items.
◆ operator-()
const_iterator rttr::variant_sequential_view::const_iterator::operator- | ( | int | i | ) | const |
Returns an iterator to the item at i positions backward from this iterator.
◆ operator--() [1/2]
const_iterator & rttr::variant_sequential_view::const_iterator::operator-- | ( | ) |
Pre-decrement operator makes the preceding item current and returns an iterator to the new current item.
- Remarks
- Calling this function on and iterator with value variant_sequential_view::begin() leads to undefined behaviour.
◆ operator--() [2/2]
const_iterator rttr::variant_sequential_view::const_iterator::operator-- | ( | int | ) |
Post-decrement operator makes the preceding item current and returns an iterator to the previously current item.
◆ operator-=()
const_iterator & rttr::variant_sequential_view::const_iterator::operator-= | ( | int | i | ) |
Returns an iterator to the item at i positions backward from this iterator.
◆ operator=()
const_iterator & rttr::variant_sequential_view::const_iterator::operator= | ( | const_iterator | other | ) |
Assigns other
to this
.
◆ operator==()
bool rttr::variant_sequential_view::const_iterator::operator== | ( | const const_iterator & | other | ) | const |
Returns true
if other
points to the same item as this iterator; otherwise returns false.
- See also
- operator!=
The documentation for this class was generated from the following file:
Generated on Fri Jan 26 2024 00:00:00 for rttr - 0.9.7 by doxygen.