std::generator<Ref,V,Allocator>::iterator

From cppreference.com

Compiler support
Freestanding and hosted
Language
Standard library
Standard library headers
Named requirements
Feature test macros(C++20)
Language support library
Concepts library(C++20)
Diagnostics library
Memory management library
Metaprogramming library(C++11)
General utilities library
Containers library
Iterators library
Ranges library(C++20)
Algorithms library
Strings library
Text processing library
Numerics library
Date and time library
Input/output library
Filesystem library(C++17)
Concurrency support library(C++11)
Execution control library(C++26)
Technical specifications
Symbols index
External libraries

[edit]

Utilities library

Language support

Type support (basic types, RTTI)

Library feature-test macros(C++20)

Program utilities

Variadic functions

initializer_list

(C++11)

is_constant_evaluated

(C++20)

is_within_lifetime

(C++26)

source_location

(C++20)

Coroutine support(C++20)

Contract support(C++26)

Three-way comparison

three_way_comparablethree_way_comparable_with

(C++20)(C++20)

strong_ordering

(C++20)

weak_ordering

(C++20)

partial_ordering

(C++20)

common_comparison_category

(C++20)

compare_three_way_result

(C++20)

(C++20)

(C++20)

(C++20)

(C++20)

compare_strong_order_fallback

(C++20)

compare_weak_order_fallback

(C++20)

compare_partial_order_fallback

(C++20)

is_eqis_ltis_lteq

(C++20)(C++20)(C++20)

is_neqis_gtis_gteq

(C++20)(C++20)(C++20)

General utilities

Function objects
Bit manipulation(C++20)
C-style bit manipulation(C++26)
bitset
hash (C++11)

Relational operators(deprecated in C++20)

rel_ops::operator!=rel_ops::operator>

rel_ops::operator<=rel_ops::operator>=

Integer comparison functions

cmp_equalcmp_lesscmp_less_than

(C++20)(C++20)(C++20)

cmp_not_equalcmp_greatercmp_greater_than

(C++20)(C++20)(C++20)

in_range

(C++20)

Swap andtype operations

swap
ranges::swap (C++20)
exchange (C++14)
declval (C++11)
to_underlying (C++23)

forward (C++11)
forward_like (C++23)
move (C++11)
move_if_noexcept (C++11)
as_const (C++17)

Common vocabulary types

pair
tuple (C++11)
optional (C++17)
any (C++17)
variant (C++17)

tuple_size (C++11)
tuple_element (C++11)
apply (C++17)
make_from_tuple (C++17)
expected (C++23)

[edit]

Coroutine support

Coroutine traits
coroutine_traits (C++20)
Coroutine handle
coroutine_handle (C++20)
No-op coroutines
noop_coroutine_promise (C++20)
noop_coroutine (C++20)
Trivial awaitables
suspend_never (C++20)
suspend_always (C++20)
Range generators
generator (C++23)

[edit]

Ranges library

Range access

begin
cbegin
end
cend

rbegin
crbegin
rend
crend

size
ssize
data
cdata

reserve_hint (C++26)
empty

Range conversions
std::from_range_t std::from_range (C++23)(C++23)
to (C++23)

Dangling iterator handling
dangling
borrowed_iterator_t
borrowed_subrange_t

Range primitives

range_size_trange_difference_trange_value_t
elements_of (C++23)

iterator_tconst_iterator_tsentinel_tconst_sentinel_t

(C++23)(C++23)

range_reference_trange_const_reference_trange_rvalue_reference_trange_common_reference_t

(C++23)

Range concepts

range
borrowed_range
common_range

sized_range
viewable_range
view

input_range
output_range
forward_range

bidirectional_range
random_access_range
contiguous_range

approximately_sized_range (C++26)
constant_range (C++23)

empty_viewviews::empty

single_viewviews::single

basic_istream_viewviews::istream

iota_viewviews::iota

repeat_viewviews::repeat

(C++23)(C++23)

Range adaptors

views::all_tviews::all
as_rvalue_viewviews::as_rvalue (C++23)(C++23)
filter_viewviews::filter
transform_viewviews::transform
take_viewviews::take
take_while_viewviews::take_while
common_viewviews::common
views::counted
to_input_viewviews::to_input (C++26)(C++26)

ref_view
drop_viewviews::drop
drop_while_viewviews::drop_while
lazy_split_viewviews::lazy_split
split_viewviews::split
join_viewviews::join
join_with_viewviews::join_with (C++23)(C++23)
concat_viewviews::concat (C++26)(C++26)
cache_latest_viewviews::cache_latest (C++26)(C++26)

owning_view
reverse_viewviews::reverse
as_const_viewviews::as_const (C++23)(C++23)
elements_viewviews::elements
keys_viewviews::keys
values_viewviews::values
enumerate_viewviews::enumerate (C++23)(C++23)
zip_viewviews::zip (C++23)(C++23)
zip_transform_viewviews::zip_transform (C++23)(C++23)

adjacent_viewviews::adjacent (C++23)(C++23)
views::pairwise (C++23)
adjacent_transform_viewviews::adjacent_transform (C++23)(C++23)
views::pairwise_transform (C++23)
chunk_viewviews::chunk (C++23)(C++23)
slide_viewviews::slide (C++23)(C++23)
chunk_by_viewviews::chunk_by (C++23)(C++23)
stride_viewviews::stride (C++23)(C++23)
cartesian_product_viewviews::cartesian_product (C++23)(C++23)

Range generators
std::generator (C++23)

Range adaptor closure objects
range_adaptor_closure (C++23)

Range adaptor objects

Helper items

copyable-box
movable-box

(until C++23) (C++23)

simple-view
non-propagating-cache

[edit]

std::generator

Member functions
generator::generator
generator::~generator
generator::operator=
generator::begin
generator::end
promise_type
generator::promise_type::get_return_object
generator::promise_type::initial_suspend
generator::promise_type::final_suspend
generator::promise_type::yield_value
generator::promise_type::return_void
generator::promise_type::unhandled_exception
generator::promise_type::operator new
generator::promise_type::operator delete
*Iterator*
generator::iterator::iterator
generator::iterator::operator=
generator::iterator::operator*
generator::iterator::operator++ generator::iterator::operator++(int)
operator==(generator::iterator, std::default_sentinel_t)

[edit]

class/iterator/;		(exposition only*)

The return type ofgenerator::begin. Modelsindirectly_readable andinput_iterator.

[edit]Member types

Member type	Definition
`value_type`	`std::generator::value`
`difference_type`	std::ptrdiff_t

[edit]Data members

Member	Description
std::coroutine_handle<std::generator::promise_type>`coroutine_`	The coroutine handle (exposition-only member object*)

[edit]Member functions

(constructor)	constructs an iterator (public member function)
operator=	assigns another iterator (public member function)
operator*	returns an underlying value (public member function)
operator++operator++(int)	advances the iterator (public member function)

std::generator::iterator::iterator

/iterator/(/iterator/&& other)noexcept;		(since C++23)

Initializescoroutine_ withstd::exchange(other.coroutine_,{});.

std::generator::iterator::operator=

/iterator/& operator=(/iterator/&& other)noexcept;		(since C++23)

Equivalent tocoroutine_=std::exchange(other.coroutine_,{});.

Returns:*this.

std::generator::iterator::operator*

reference operator*()const noexcept(std::is_nothrow_copy_constructible_v<reference>);		(since C++23)

Letreference be thestd::generator's underlying type.
Let for some generator objectx itscoroutine_ be in the stack*x.active_.
Letx.active_->top() refer to a suspended coroutine with promise objectp.

Equivalent toreturnstatic_cast<reference>(*p.value_);.

std::generator::iterator::operator++

constexpr/iterator/& operator++();	(1)	(since C++23)
constexprvoid operator++(int);	(2)	(since C++23)

1) Let for some generator objectx thecoroutine_ be in the stack*x.active_.

Equivalent tox.active_->top().resume().

Returns:*this.

2) Equivalent to++*this;.

[edit]Non-member functions

operator==

(C++23)

compares the underlying iterator with a sentinel
(function)

operator==(std::generator::iterator)

friendbool operator==(const/iterator/& i,std::default_sentinel_t);		(since C++23)

Equivalent toreturn i.coroutine_.done();.

The!= operator issynthesized fromoperator==.

This function is not visible to ordinaryunqualified orqualified lookup, and can only be found byargument-dependent lookup whenstd::generator::iterator is an associated class of the arguments.