seqan3::detail::async_input_buffer_view< urng_t >::iterator Class Reference

The iterator of the seqan3::detail::async_input_buffer_view. More...

#include <seqan3/io/views/async_input_buffer.hpp>

Public Types
Associated types
using	difference_type = std::iter_difference_t< urng_iterator_type >
	Difference type.
using	value_type = std::iter_value_t< urng_iterator_type >
	Value type.
using	pointer = detail::iter_pointer_t< urng_iterator_type >
	Pointer type.
using	reference = std::iter_reference_t< urng_iterator_type >
	Reference type.
using	iterator_category = std::input_iterator_tag
	Iterator category.
using	iterator_concept = iterator_category
	Iterator concept.

Public Member Functions
Construction, destruction and assignment
Not explicitly noexcept because this depends on construction/copy/... of value_type.
	iterator ()=default
	Defaulted.
	iterator (iterator const &rhs)=default
	Defaulted.
	iterator (iterator &&rhs)=default
	Defaulted.
iterator &	operator= (iterator const &rhs)=default
	Defaulted.
iterator &	operator= (iterator &&rhs)=default
	Defaulted.
	~iterator () noexcept=default
	Defaulted.
	iterator (contrib::fixed_buffer_queue< std::ranges::range_value_t< urng_t > > &buffer) noexcept
	Constructing from the underlying seqan3::async_input_buffer_view.
Access operations
reference	operator* () const noexcept
	Return the cached value.
pointer	operator-> () const noexcept
	Returns pointer to the pointed-to object.
Iterator operations
iterator &	operator++ () noexcept
	Pre-increment.
void	operator++ (int) noexcept
	Post-increment.

Private Types
using	sentinel_type = std::default_sentinel_t
	The sentinel type to compare to.

Private Attributes
bool	at_end = false
	Whether this iterator is at end (the buffer is empty and closed).
contrib::fixed_buffer_queue< std::ranges::range_value_t< urng_t > > *	buffer_ptr = nullptr
	The pointer to the associated view.
std::ranges::range_value_t< urng_t >	cached_value
	The cached value this iterator holds.

Friends
Comparison operators
constexpr bool	operator== (iterator const &lhs, std::default_sentinel_t const &) noexcept
	Compares for equality with sentinel.
constexpr bool	operator== (std::default_sentinel_t const &, iterator const &rhs) noexcept
	Compares for equality with sentinel.
constexpr bool	operator!= (iterator const &lhs, std::default_sentinel_t const &) noexcept
	Compares for inequality with sentinel.
constexpr bool	operator!= (std::default_sentinel_t const &, iterator const &rhs) noexcept
	Compares for inequality with sentinel.

Detailed Description

template<std::ranges::range urng_t>
class seqan3::detail::async_input_buffer_view< urng_t >::iterator

The iterator of the seqan3::detail::async_input_buffer_view.

Friends And Related Symbol Documentation

operator!=

template<std::ranges::range urng_t>

constexpr bool operator!= ( std::default_sentinel_t const &  , iterator const &  rhs  )

friend

Compares for inequality with sentinel.

operator==

template<std::ranges::range urng_t>

constexpr bool operator== ( std::default_sentinel_t const &  , iterator const &  rhs  )

friend

Compares for equality with sentinel.

---

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

• async_input_buffer.hpp