simdjson::SIMDJSON_IMPLEMENTATION::ondemand::document_stream::iterator Class Reference

Public Types
using	value_type = simdjson_result< document >
using	reference = simdjson_result< ondemand::document_reference >
using	pointer = void
using	difference_type = std::ptrdiff_t
using	iterator_category = std::input_iterator_tag

Public Member Functions
simdjson_inline	iterator () noexcept
	Default constructor.
simdjson_inline	iterator (const iterator &other) noexcept=default
simdjson_inline reference	operator* () noexcept
	Get the current document (or error).
iterator &	operator++ () noexcept
	Advance to the next document (prefix).
simdjson_inline bool	operator!= (const iterator &other) const noexcept
	Check if we're at the end yet.
simdjson_inline bool	operator== (const iterator &other) const noexcept
error_code	error () const noexcept
	Returns error of the stream (if any).
bool	at_end () const noexcept
	Returns whether the iterator is at the end.

Detailed Description

Definition at line 122 of file document_stream.h.

Member Typedef Documentation

difference_type

using simdjson::SIMDJSON_IMPLEMENTATION::ondemand::document_stream::iterator::difference_type = std::ptrdiff_t

Definition at line 127 of file document_stream.h.

iterator_category

using simdjson::SIMDJSON_IMPLEMENTATION::ondemand::document_stream::iterator::iterator_category = std::input_iterator_tag

Definition at line 128 of file document_stream.h.

pointer

using simdjson::SIMDJSON_IMPLEMENTATION::ondemand::document_stream::iterator::pointer = void

Definition at line 126 of file document_stream.h.

reference

using simdjson::SIMDJSON_IMPLEMENTATION::ondemand::document_stream::iterator::reference = simdjson_result<ondemand::document_reference>

Definition at line 125 of file document_stream.h.

value_type

using simdjson::SIMDJSON_IMPLEMENTATION::ondemand::document_stream::iterator::value_type = simdjson_result<document>

Definition at line 124 of file document_stream.h.

Constructor & Destructor Documentation

iterator()

simdjson_inline simdjson::SIMDJSON_IMPLEMENTATION::ondemand::document_stream::iterator::iterator ( )

noexcept

Default constructor.

Definition at line 146 of file document_stream-inl.h.

Member Function Documentation

at_end()

simdjson_inline bool simdjson::SIMDJSON_IMPLEMENTATION::ondemand::document_stream::iterator::at_end ( ) const

inlinenoexcept

Returns whether the iterator is at the end.

Definition at line 185 of file document_stream-inl.h.

error()

error_code simdjson::SIMDJSON_IMPLEMENTATION::ondemand::document_stream::iterator::error ( ) const

inlinenoexcept

Returns error of the stream (if any).

Definition at line 388 of file document_stream-inl.h.

operator!=()

simdjson_inline bool simdjson::SIMDJSON_IMPLEMENTATION::ondemand::document_stream::iterator::operator!= ( const iterator &  other ) const

noexcept

Check if we're at the end yet.

Parameters

other

the end iterator to compare to.

Definition at line 190 of file document_stream-inl.h.

operator*()

simdjson_inline simdjson_result< ondemand::document_reference > simdjson::SIMDJSON_IMPLEMENTATION::ondemand::document_stream::iterator::operator* ( )

noexcept

Get the current document (or error).

Definition at line 154 of file document_stream-inl.h.

operator++()

simdjson_inline document_stream::iterator & simdjson::SIMDJSON_IMPLEMENTATION::ondemand::document_stream::iterator::operator++ ( )

inlinenoexcept

Advance to the next document (prefix).

Definition at line 158 of file document_stream-inl.h.

operator==()

simdjson_inline bool simdjson::SIMDJSON_IMPLEMENTATION::ondemand::document_stream::iterator::operator== ( const iterator &  other ) const

noexcept

Definition at line 194 of file document_stream-inl.h.

---

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

• include/simdjson/generic/ondemand/document_stream.h
• include/simdjson/generic/ondemand/document_stream-inl.h