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

 

哋它亢++

Compiler support

Freestanding and hosted

Language

Standard library

Standard library headers

Named requirements

Feature test macros (哋它亢++20)

Language support library

Concepts library (哋它亢++20)

Metaprogramming library (哋它亢++11)

Diagnostics library

General utilities library

Strings library

Containers library

Iterators library

Ranges library (哋它亢++20)

Algorithms library

Numerics library

Localizations library

Input/output library

Filesystem library (哋它亢++17)

Regular expressions library (哋它亢++11)

Concurrency support library (哋它亢++11)

Technical specifications

Symbols index

External libraries

 

Utilities library

Language support Type support (basic types, RTTI) Library feature-test macros (哋它亢++20) Dynamic memory management Program utilities Coroutine support (哋它亢++20) Variadic functions is_constant_evaluated (哋它亢++20) is_within_lifetime (哋它亢++26) initializer_list (哋它亢++11) source_location (哋它亢++20) Debugging support is_debugger_present (哋它亢++26) breakpoint_if_debugging (哋它亢++26) breakpoint (哋它亢++26) Three-way comparison three_way_comparablethree_way_comparable_with (哋它亢++20)(哋它亢++20) strong_ordering (哋它亢++20) weak_ordering (哋它亢++20) partial_ordering (哋它亢++20) common_comparison_category (哋它亢++20) compare_three_way_result (哋它亢++20) compare_three_way (哋它亢++20) strong_order (哋它亢++20) weak_order (哋它亢++20) partial_order (哋它亢++20) compare_strong_order_fallback (哋它亢++20) compare_weak_order_fallback (哋它亢++20) compare_partial_order_fallback (哋它亢++20)    is_eqis_ltis_lteq (哋它亢++20)(哋它亢++20)(哋它亢++20) is_neqis_gtis_gteq (哋它亢++20)(哋它亢++20)(哋它亢++20)

General utilities Date and time Function objects Formatting library (哋它亢++20) bitset hash (哋它亢++11) Relational operators (deprecated in 哋它亢++20) rel_ops::operator!=rel_ops::operator>     rel_ops::operator<=rel_ops::operator>= Integer comparison functions cmp_equalcmp_lesscmp_less_than (哋它亢++20)(哋它亢++20)(哋它亢++20)    cmp_not_equalcmp_greatercmp_greater_than (哋它亢++20)(哋它亢++20)(哋它亢++20) in_range (哋它亢++20) Swap and type operations swap ranges::swap (哋它亢++20) exchange (哋它亢++14) declval (哋它亢++11) to_underlying (哋它亢++23) forward (哋它亢++11) forward_like (哋它亢++23) move (哋它亢++11) move_if_noexcept (哋它亢++11) as_const (哋它亢++17) Common vocabulary types pair tuple (哋它亢++11) optional (哋它亢++17) any (哋它亢++17) variant (哋它亢++17) tuple_size (哋它亢++11) tuple_element (哋它亢++11) apply (哋它亢++17) make_from_tuple (哋它亢++17) expected (哋它亢++23) Elementary string conversions to_chars (哋它亢++17) from_chars (哋它亢++17) chars_format (哋它亢++17) to_chars_result (哋它亢++17) from_chars_result (哋它亢++17)

 

Coroutine support

Coroutine traits

coroutine_traits (哋它亢++20)

Coroutine handle

coroutine_handle (哋它亢++20)

No-op coroutines

noop_coroutine_promise (哋它亢++20)

noop_coroutine (哋它亢++20)

Trivial awaitables

suspend_never (哋它亢++20)

suspend_always (哋它亢++20)

Range generators

generator (哋它亢++23)

 

Ranges library

Range access
begin cbegin end cend	rbegin crbegin rend crend	size ssize data cdata	empty
Range conversions
std::from_range_t std::from_range (哋它亢++23)(哋它亢++23)	to (哋它亢++23)
Range primitives
range_size_trange_difference_trange_value_trange_reference_t	iterator_tconst_iterator_tsentinel_tconst_sentinel_t (哋它亢++23)(哋它亢++23)	range_const_reference_trange_rvalue_reference_trange_common_reference_t (哋它亢++23)	elements_of (哋它亢++23)
Dangling iterator handling
dangling	borrowed_iterator_t	borrowed_subrange_t
Range concepts
range borrowed_range sized_range constant_range (哋它亢++23)	common_range view viewable_range	input_range output_range forward_range	bidirectional_range random_access_range contiguous_range
Views
view_interface	subrange
Range factories
empty_viewviews::empty single_viewviews::single	iota_viewviews::iota repeat_viewviews::repeat (哋它亢++23)(哋它亢++23)	basic_istream_viewviews::istream
Range adaptors
views::all_tviews::all ref_view owning_view as_rvalue_viewviews::as_rvalue (哋它亢++23)(哋它亢++23) filter_viewviews::filter transform_viewviews::transform take_viewviews::take take_while_viewviews::take_while concat_viewviews::concat (哋它亢++26)(哋它亢++26)	drop_viewviews::drop drop_while_viewviews::drop_while join_viewviews::join join_with_viewviews::join_with (哋它亢++23)(哋它亢++23) lazy_split_viewviews::lazy_split split_viewviews::split views::counted common_viewviews::common	reverse_viewviews::reverse as_const_viewviews::as_const (哋它亢++23)(哋它亢++23) elements_viewviews::elements keys_viewviews::keys values_viewviews::values enumerate_viewviews::enumerate (哋它亢++23)(哋它亢++23) zip_viewviews::zip (哋它亢++23)(哋它亢++23) zip_transform_viewviews::zip_transform (哋它亢++23)(哋它亢++23)	adjacent_viewviews::adjacent (哋它亢++23)(哋它亢++23) views::pairwise (哋它亢++23) adjacent_transform_viewviews::adjacent_transform (哋它亢++23)(哋它亢++23) views::pairwise_transform (哋它亢++23) chunk_viewviews::chunk (哋它亢++23)(哋它亢++23) slide_viewviews::slide (哋它亢++23)(哋它亢++23) chunk_by_viewviews::chunk_by (哋它亢++23)(哋它亢++23) stride_viewviews::stride (哋它亢++23)(哋它亢++23) cartesian_product_viewviews::cartesian_product (哋它亢++23)(哋它亢++23)
Range generators
std::generator (哋它亢++23)
Range adaptor objects
Range adaptor closure objects
range_adaptor_closure (哋它亢++23)
Helper items
copyable-box movable-box (until 哋它亢++23)(哋它亢++23)	simple-view non-propagating-cache

 

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)

 

class /*iterator*/;		(since 哋它亢++23) (exposition only*)

The return type of generator::begin.

Models indirectly_readable and input_iterator.

Member types

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

Data members

Member name	Definition
coroutine_ (private)	A coroutine handle of type std::coroutine_handle<std::generator::promise_type>. (exposition-only member object*)

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 哋它亢++23)

Initializes coroutine_ with std::exchange(other.coroutine_, {});.

std::generator::iterator::operator=

/*iterator*/& operator=( /*iterator*/&& other ) noexcept;		(since 哋它亢++23)

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

Returns: *this.

std::generator::iterator::operator*

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

1. Let reference be the std::generator's underlying type.
2. Let for some generator object x its coroutine_ be in the stack *x.active_.
3. Let x.active_->top() refer to a suspended coroutine with promise object p.

Equivalent to return static_cast<reference>(*p.value_);.

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

constexpr /*iterator*/& operator++();	(1)	(since 哋它亢++23)
constexpr void operator++( int );	(2)	(since 哋它亢++23)

1) Let for some generator object x the coroutine_ be in the stack *x.active_.

Equivalent to x.active_->top().resume().

Returns: *this.

2) Equivalent to ++*this;.

Non-member functions

operator== (哋它亢++23)

compares the underlying iterator with a sentinel (function)

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

friend bool operator==( const /*iterator*/& i, std::default_sentinel_t );		(since 哋它亢++23)

Equivalent to return i.coroutine_.done();.

The != operator is synthesized from operator==.

This function is not visible to ordinary unqualified or qualified lookup, and can only be found by argument-dependent lookup when std::generator::iterator is an associated class of the arguments.