simdjson::dom::document_stream::iterator Class Reference

An iterator through a forward-only stream of documents. More...

#include <document_stream.h>

Public Types
using	value_type = simdjson_result< element >
using	reference = value_type
using	difference_type = std::ptrdiff_t
using	iterator_category = std::input_iterator_tag

Public Member Functions
simdjson_inline	iterator () noexcept
	Default constructor.
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.

Detailed Description

An iterator through a forward-only stream of documents.

Definition at line 115 of file document_stream.h.

Member Typedef Documentation

difference_type

using simdjson::dom::document_stream::iterator::difference_type = std::ptrdiff_t

Definition at line 120 of file document_stream.h.

iterator_category

using simdjson::dom::document_stream::iterator::iterator_category = std::input_iterator_tag

Definition at line 122 of file document_stream.h.

reference

using simdjson::dom::document_stream::iterator::reference = value_type

Definition at line 118 of file document_stream.h.

value_type

using simdjson::dom::document_stream::iterator::value_type = simdjson_result<element>

Definition at line 117 of file document_stream.h.

Constructor & Destructor Documentation

iterator()

simdjson_inline simdjson::dom::document_stream::iterator::iterator ( )

noexcept

Default constructor.

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

Member Function Documentation

operator!=()

simdjson_inline bool simdjson::dom::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 183 of file document_stream-inl.h.

operator*()

simdjson_inline document_stream::iterator::reference simdjson::dom::document_stream::iterator::operator* ( )

noexcept

Get the current document (or error).

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

operator++()

simdjson_inline document_stream::iterator & simdjson::dom::document_stream::iterator::operator++ ( )

inlinenoexcept

Advance to the next document (prefix).

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

---

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

• include/simdjson/dom/document_stream.h
• include/simdjson/dom/document_stream-inl.h