ALib C++ Library
Library Version: 2402 R1
Documentation generated by doxygen
Loading...
Searching...
No Matches
Exception::IteratorType< TConstOrMutableMessage > Class Template Reference

Description:

template<typename TConstOrMutableMessage>
class alib::lang::Exception::IteratorType< TConstOrMutableMessage >

Implementation of std::ForwardIterator that iterates all Message entries of an Exception.

Definition at line 368 of file exception.hpp.

#include <exception.hpp>

Collaboration diagram for Exception::IteratorType< TConstOrMutableMessage >:
[legend]

Public Type Index:

using difference_type = integer
 Implementation of std::iterator_traits.
 
using iterator_category = std::forward_iterator_tag
 Implementation of std::iterator_traits.
 
using pointer = TConstOrMutableMessage*
 Implementation of std::iterator_traits.
 
using reference = TConstOrMutableMessage&
 Implementation of std::iterator_traits.
 
using value_type = Message
 Implementation of std::iterator_traits.
 

Public Method Index:

 IteratorType (detail::ExceptionEntry *_p=nullptr)
 
 IteratorType (TConstEntry *entry)
 
 IteratorType (TMutableIterator it)
 
bool operator!= (IteratorType other) const
 
TConstOrMutableMessage & operator* () const
 
IteratorTypeoperator++ ()
 
IteratorType operator++ (int)
 
TConstOrMutableMessage * operator-> () const
 
bool operator== (IteratorType other) const
 

Type Definition Details:

◆ difference_type

template<typename TConstOrMutableMessage >
using difference_type = integer

Implementation of std::iterator_traits.

Definition at line 377 of file exception.hpp.

◆ iterator_category

template<typename TConstOrMutableMessage >
using iterator_category = std::forward_iterator_tag

Implementation of std::iterator_traits.

Definition at line 375 of file exception.hpp.

◆ pointer

template<typename TConstOrMutableMessage >
using pointer = TConstOrMutableMessage*

Implementation of std::iterator_traits.

Definition at line 378 of file exception.hpp.

◆ reference

template<typename TConstOrMutableMessage >
using reference = TConstOrMutableMessage&

Implementation of std::iterator_traits.

Definition at line 379 of file exception.hpp.

◆ value_type

template<typename TConstOrMutableMessage >
using value_type = Message

Implementation of std::iterator_traits.

Definition at line 376 of file exception.hpp.

Field Details:

◆ p

template<typename TConstOrMutableMessage >
detail::ExceptionEntry* p
protected

The pointer to the actual node.

Definition at line 372 of file exception.hpp.

Constructor(s) / Destructor Details::

◆ IteratorType() [1/3]

template<typename TConstOrMutableMessage >
IteratorType ( detail::ExceptionEntry * _p = nullptr)
inlineexplicit

Constructor.

Parameters
_pOur initial value

Definition at line 384 of file exception.hpp.

◆ IteratorType() [2/3]

template<typename TConstOrMutableMessage >
IteratorType ( TConstEntry * entry)
inline

Constructor taking a constant entry pointer. Available for the constant version of this iterator only.

Parameters
entryThe initial message entry.

Definition at line 392 of file exception.hpp.

◆ IteratorType() [3/3]

template<typename TConstOrMutableMessage >
IteratorType ( TMutableIterator it)
inline

Constructor taking a mutable iterator. Available for the constant version of this iterator only.

Parameters
itThe mutable iterator to used to construct this constant one.

Definition at line 401 of file exception.hpp.

Method Details:

◆ operator!=()

template<typename TConstOrMutableMessage >
bool operator!= ( IteratorType< TConstOrMutableMessage > other) const
inline

Comparison operator.

Parameters
otherThe iterator to compare ourselves to.
Returns
true if this and given iterator are not equal, false otherwise.

Definition at line 435 of file exception.hpp.

◆ operator*()

template<typename TConstOrMutableMessage >
TConstOrMutableMessage & operator* ( ) const
inline

Retrieves the message that this iterator references.

Returns
The message reference.

Definition at line 442 of file exception.hpp.

◆ operator++() [1/2]

template<typename TConstOrMutableMessage >
IteratorType & operator++ ( )
inline

Prefix increment operator.

Returns
A reference to ourselves.

Definition at line 409 of file exception.hpp.

◆ operator++() [2/2]

template<typename TConstOrMutableMessage >
IteratorType operator++ ( int )
inline

Postfix increment operator.

Returns
A new iterator object that is not increased, yet.

Definition at line 417 of file exception.hpp.

Here is the call graph for this function:

◆ operator->()

template<typename TConstOrMutableMessage >
TConstOrMutableMessage * operator-> ( ) const
inline

Retrieves the pointer to the message that this iterator references.

Returns
The message pointer.

Definition at line 449 of file exception.hpp.

◆ operator==()

template<typename TConstOrMutableMessage >
bool operator== ( IteratorType< TConstOrMutableMessage > other) const
inline

Comparison operator.

Parameters
otherThe iterator to compare ourselves to.
Returns
true if this and given iterator are equal, false otherwise.

Definition at line 427 of file exception.hpp.


The documentation for this class was generated from the following file: