GenericInputStream< T, D >::Iterator Class Reference

#include <genesis/utils/containers/generic_input_stream.hpp>

Detailed Description

template<class T, class D = EmptyGenericInputStreamData>
class genesis::utils::GenericInputStream< T, D >::Iterator

Internal iterator over the data.

Definition at line 196 of file generic_input_stream.hpp.

Public Member Functions
	Iterator ()=default
	Default constructor for empty (past-the-end) data. More...
	Iterator (self_type &&)=default
	Iterator (self_type const &)=default
	~Iterator ()=default
Data const &	data () const
	Access the data stored in the iterator. More...
	operator bool () const
	Return whether the iterator is at a valid position, that is, if its input has yielded an element. More...
bool	operator!= (self_type const &other) const
value_type &	operator* ()
const value_type &	operator* () const
self_type &	operator++ ()
value_type *	operator-> ()
const value_type *	operator-> () const
Iterator &	operator= (self_type &&)=default
Iterator &	operator= (self_type const &)=default
bool	operator== (self_type const &other) const
	Compare two iterators for equality. More...

Public Types
using	Data = D
using	difference_type = std::ptrdiff_t
using	iterator_category = std::input_iterator_tag
using	pointer = value_type const *
using	reference = value_type const &
using	self_type = GenericInputStream< T, D >::Iterator
using	value_type = T

Public Attributes
friend	GenericInputStream

Constructor & Destructor Documentation

Iterator() [1/3]

Iterator ( )

default

Default constructor for empty (past-the-end) data.

Public, so that an empty default instance can be used in a (placeholder) variable before assining it a value (e.g., when default-constructing an object that holds a GenericInputStream instance).

~Iterator()

~Iterator ( )

default

Iterator() [2/3]

Iterator ( self_type const &  )

default

Iterator() [3/3]

Iterator ( self_type &&  )

default

Member Function Documentation

data()

Data const& data ( ) const

inline

Access the data stored in the iterator.

Definition at line 309 of file generic_input_stream.hpp.

operator bool()

operator bool ( ) const

inline

Return whether the iterator is at a valid position, that is, if its input has yielded an element.

Definition at line 358 of file generic_input_stream.hpp.

operator!=()

bool operator!= ( self_type const &  other ) const

inline

Definition at line 390 of file generic_input_stream.hpp.

operator*() [1/2]

value_type& operator* ( )

inline

Definition at line 298 of file generic_input_stream.hpp.

operator*() [2/2]

const value_type& operator* ( ) const

inline

Definition at line 290 of file generic_input_stream.hpp.

operator++()

self_type& operator++ ( )

inline

Definition at line 341 of file generic_input_stream.hpp.

operator->() [1/2]

value_type* operator-> ( )

inline

Definition at line 282 of file generic_input_stream.hpp.

operator->() [2/2]

const value_type* operator-> ( ) const

inline

Definition at line 274 of file generic_input_stream.hpp.

operator=() [1/2]

Iterator& operator= ( self_type &&  )

default

operator=() [2/2]

Iterator& operator= ( self_type const &  )

default

operator==()

bool operator== ( self_type const &  other ) const

inline

Compare two iterators for equality.

Any two iterators that are copies of each other without having moved will compare equal, as long as neither of them is past-the-end. A valid (not past-the-end) iterator and an end() iterator will not compare equal, no matter from which GenericInputStream they were created. Two past-the-end iterators compare equal.

Definition at line 374 of file generic_input_stream.hpp.

Member Typedef Documentation

Data

using Data = D

Definition at line 211 of file generic_input_stream.hpp.

difference_type

using difference_type = std::ptrdiff_t

Definition at line 208 of file generic_input_stream.hpp.

iterator_category

using iterator_category = std::input_iterator_tag

Definition at line 209 of file generic_input_stream.hpp.

pointer

using pointer = value_type const*

Definition at line 206 of file generic_input_stream.hpp.

reference

using reference = value_type const&

Definition at line 207 of file generic_input_stream.hpp.

self_type

using self_type = GenericInputStream<T, D>::Iterator

Definition at line 204 of file generic_input_stream.hpp.

value_type

using value_type = T

Definition at line 205 of file generic_input_stream.hpp.

Member Data Documentation

GenericInputStream

friend GenericInputStream

Definition at line 268 of file generic_input_stream.hpp.

---

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

• generic_input_stream.hpp