HikoGUI
A low latency retained GUI
Loading...
Searching...
No Matches
Public Types | Public Member Functions
v1::generator< T, Allocator >::iterator Class Reference

#include <hikogui/generator.hpp>

Public Types

using difference_type = ptrdiff_t
 
using value_type = std::remove_cv_t<value_type>
 
using pointer = value_type *
 
using reference = value_type &
 
using iterator_category = std::input_iterator_tag
 

Public Member Functions

 iterator (handle_type coroutine)
 
iteratoroperator++ ()
 Resume the generator-function.
 
value_proxy operator++ (int)
 
value_type const & operator* () const
 Retrieve the value co_yielded by the generator-function.
 
value_type const * operator-> () const
 
bool operator== (std::default_sentinel_t) const
 Check if the generator-function has finished.
 

Detailed Description

template<typename T, typename Allocator = std::allocator<std::byte>>
class v1::generator< T, Allocator >::iterator

A forward iterator which iterates through values co_yieled by the generator-function.

Member Function Documentation

◆ operator*()

template<typename T , typename Allocator = std::allocator<std::byte>>
value_type const & v1::generator< T, Allocator >::iterator::operator* ( ) const
inline

Retrieve the value co_yielded by the generator-function.

◆ operator++()

template<typename T , typename Allocator = std::allocator<std::byte>>
iterator & v1::generator< T, Allocator >::iterator::operator++ ( )
inline

Resume the generator-function.

◆ operator==()

template<typename T , typename Allocator = std::allocator<std::byte>>
bool v1::generator< T, Allocator >::iterator::operator== ( std::default_sentinel_t ) const
inline

Check if the generator-function has finished.


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