apf::discard_iterator Class Reference

An iterator which does nothing. More...

#include <apf/iterator.h>

Classes
struct	output_proxy
	Helper class for discard_iterator. More...

Public Types
using	iterator_category = std::output_iterator_tag
using	value_type = void
using	difference_type = void
using	pointer = void
using	reference = output_proxy

Public Member Functions
reference	operator* ()
	Dereference operator. More...
self &	operator++ ()
	Pre-increment operator (does nothing!) More...
bool	operator== (const self &) const
	Equality operator – always true! More...
self	operator++ (int)
	Postincrement operator (using preincrement operator). More...
bool	operator!= (const self &rhs) const
	Unequality operator (using equality operator). More...

Detailed Description

An iterator which does nothing.

The discard_iterator has the features of an output iterator, but additionally, the += operator can be used. Two discard_iterators can be compared with == and !=, but they are always equal!

• on dereferenciation and assignment, the assigned value is discarded.
• The += operator can also be used with similar behaviour

See also

output_proxy

Definition at line 1350 of file iterator.h.

Member Typedef Documentation

iterator_category

using apf::discard_iterator::iterator_category = std::output_iterator_tag

Definition at line 1356 of file iterator.h.

value_type

using apf::discard_iterator::value_type = void

Definition at line 1357 of file iterator.h.

difference_type

using apf::discard_iterator::difference_type = void

Definition at line 1358 of file iterator.h.

pointer

using apf::discard_iterator::pointer = void

Definition at line 1359 of file iterator.h.

reference

using apf::discard_iterator::reference = output_proxy

Definition at line 1373 of file iterator.h.

Member Function Documentation

operator*()

reference apf::discard_iterator::operator* ( )

inline

Dereference operator.

Returns

a temporary object of type output_proxy

Definition at line 1377 of file iterator.h.

operator++() [1/2]

self & apf::discard_iterator::operator++ ( )

inline

Pre-increment operator (does nothing!)

Definition at line 1383 of file iterator.h.

operator==()

bool apf::discard_iterator::operator== ( const self &  ) const

inline

Equality operator – always true!

Definition at line 1386 of file iterator.h.

operator++() [2/2]

self apf::discard_iterator::operator++ ( int  )

inline

Postincrement operator (using preincrement operator).

Definition at line 1388 of file iterator.h.

operator!=()

bool apf::discard_iterator::operator!= ( const self &  rhs ) const

inline

Unequality operator (using equality operator).

Definition at line 1389 of file iterator.h.

---

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

• apf/iterator.h