entttree::FixedItemGenerator< T > Struct Template Reference

A generator that yields exactly one item, then exhausts. More...

#include <generator.h>

Public Member Functions
	FixedItemGenerator (T &&item)
	FixedItemGenerator (const T &item)
bool	next ()
FixedItemGenerator &	operator++ ()
const T &	operator* () const
T &	operator* ()
const T *	operator-> () const
T *	operator-> ()
bool	is_valid () const
	operator bool () const

Public Attributes
T	item
bool	yielded = false

Detailed Description

template<typename T>
struct entttree::FixedItemGenerator< T >

A generator that yields exactly one item, then exhausts.

Satisfies GeneratorConcept and is useful for creating leaf-node traversals with a single child.

Template Parameters

T	The item type.

Definition at line 227 of file generator.h.

Constructor & Destructor Documentation

FixedItemGenerator() [1/3]

template<typename T >

entttree::FixedItemGenerator< T >::FixedItemGenerator ( )

inline

Definition at line 231 of file generator.h.

FixedItemGenerator() [2/3]

template<typename T >

entttree::FixedItemGenerator< T >::FixedItemGenerator ( T &&  item )

inline

Definition at line 232 of file generator.h.

FixedItemGenerator() [3/3]

template<typename T >

entttree::FixedItemGenerator< T >::FixedItemGenerator ( const T &  item )

inline

Definition at line 233 of file generator.h.

Member Function Documentation

is_valid()

template<typename T >

bool entttree::FixedItemGenerator< T >::is_valid ( ) const

inline

Definition at line 244 of file generator.h.

next()

template<typename T >

bool entttree::FixedItemGenerator< T >::next ( )

inline

Definition at line 235 of file generator.h.

operator bool()

template<typename T >

entttree::FixedItemGenerator< T >::operator bool ( ) const

inline

Definition at line 245 of file generator.h.

operator*() [1/2]

template<typename T >

T & entttree::FixedItemGenerator< T >::operator* ( )

inline

Definition at line 240 of file generator.h.

operator*() [2/2]

template<typename T >

const T & entttree::FixedItemGenerator< T >::operator* ( ) const

inline

Definition at line 239 of file generator.h.

operator++()

template<typename T >

FixedItemGenerator & entttree::FixedItemGenerator< T >::operator++ ( )

inline

Definition at line 237 of file generator.h.

operator->() [1/2]

template<typename T >

T * entttree::FixedItemGenerator< T >::operator-> ( )

inline

Definition at line 242 of file generator.h.

operator->() [2/2]

template<typename T >

const T * entttree::FixedItemGenerator< T >::operator-> ( ) const

inline

Definition at line 241 of file generator.h.

Member Data Documentation

item

template<typename T >

T entttree::FixedItemGenerator< T >::item

Definition at line 228 of file generator.h.

yielded

template<typename T >

bool entttree::FixedItemGenerator< T >::yielded = false

Definition at line 229 of file generator.h.

---

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

• include/entttree/generator.h