Bond 0.9
C++ Bond Runtime Library API Documentation
Loading...
Searching...
No Matches
Bond::AutoStack< ValueType >::Iterator Class Reference

An iterator that visits the values of an AutoStack from the top to the bottom. More...

#include <bond/stl/autostack.h>

Public Member Functions

 Iterator () noexcept
 Constructs an Iterator that does not refer to any value.
bool operator== (const Iterator &other) const noexcept
 Returns whether two Iterators refer to the same value.
bool operator!= (const Iterator &other) const noexcept
 Returns whether two Iterators refer to different values.
ValueType & operator* () const
 Returns a reference to the value to which the Iterator refers.
ValueType * operator-> () const
 Returns a pointer to the value to which the Iterator refers.
Iterator & operator++ ()
 Advances the Iterator to the next value down the stack.
Iterator operator++ (int)
 Advances the Iterator to the next value down the stack.

Friends

class AutoStack
class ConstIterator

Detailed Description

template<typename ValueType>
class Bond::AutoStack< ValueType >::Iterator

An iterator that visits the values of an AutoStack from the top to the bottom.

Constructor & Destructor Documentation

◆ Iterator()

template<typename ValueType>
Bond::AutoStack< ValueType >::Iterator::Iterator ( )
inlinenoexcept

Constructs an Iterator that does not refer to any value.

Member Function Documentation

◆ operator!=()

template<typename ValueType>
bool Bond::AutoStack< ValueType >::Iterator::operator!= ( const Iterator & other) const
inlinenoexcept

Returns whether two Iterators refer to different values.

◆ operator*()

template<typename ValueType>
ValueType & Bond::AutoStack< ValueType >::Iterator::operator* ( ) const
inline

Returns a reference to the value to which the Iterator refers.

◆ operator++() [1/2]

template<typename ValueType>
Iterator & Bond::AutoStack< ValueType >::Iterator::operator++ ( )
inline

Advances the Iterator to the next value down the stack.

Returns
A reference to this Iterator.

◆ operator++() [2/2]

template<typename ValueType>
Iterator Bond::AutoStack< ValueType >::Iterator::operator++ ( int )
inline

Advances the Iterator to the next value down the stack.

Returns
A copy of the Iterator from before it was advanced.

◆ operator->()

template<typename ValueType>
ValueType * Bond::AutoStack< ValueType >::Iterator::operator-> ( ) const
inline

Returns a pointer to the value to which the Iterator refers.

◆ operator==()

template<typename ValueType>
bool Bond::AutoStack< ValueType >::Iterator::operator== ( const Iterator & other) const
inlinenoexcept

Returns whether two Iterators refer to the same value.

◆ AutoStack

template<typename ValueType>
friend class AutoStack
friend

◆ ConstIterator

template<typename ValueType>
friend class ConstIterator
friend

The documentation for this class was generated from the following file:
  • include/bond/stl/autostack.h