Hyper API for C++ 0.0.18618
Hyper client library for C++ applications
Loading...
Searching...
No Matches
hyperapi::ResultIterator Class Referencefinal

Iterates over a hyperapi::Result in rows (hyperapi::Row). More...

#include <Result.hpp>

Public Types

using iterator_category = std::input_iterator_tag
 
using value_type = Row
 
using difference_type = std::ptrdiff_t
 
using pointer = const Row *
 
using reference = const Row &
 

Public Member Functions

 ResultIterator (Result &result, IteratorBeginTag)
 Constructs the begin-iterator.
 
 ResultIterator (Result &result, IteratorEndTag) noexcept
 Constructs the end-iterator.
 
reference operator* () const noexcept
 Returns a reference to the current value.
 
pointer operator-> () const noexcept
 Returns a pointer to the current value.
 
ResultIteratoroperator++ ()
 Advances the iterator.
 

Detailed Description

Iterates over a hyperapi::Result in rows (hyperapi::Row).

ResultIterator is a single-pass input iterator. It reads successive rows of type hyperapi::Row from the hyperapi::Result from which it was constructed.

Definition at line 550 of file Result.hpp.

Member Typedef Documentation

◆ difference_type

using hyperapi::ResultIterator::difference_type = std::ptrdiff_t

Definition at line 554 of file Result.hpp.

◆ iterator_category

using hyperapi::ResultIterator::iterator_category = std::input_iterator_tag

Definition at line 552 of file Result.hpp.

◆ pointer

Definition at line 555 of file Result.hpp.

◆ reference

Definition at line 556 of file Result.hpp.

◆ value_type

Definition at line 553 of file Result.hpp.

Constructor & Destructor Documentation

◆ ResultIterator()

hyperapi::ResultIterator::ResultIterator ( Result result,
IteratorEndTag   
)
inlinenoexcept

Constructs the end-iterator.

Definition at line 561 of file Result.hpp.

Member Function Documentation

◆ operator*()

reference hyperapi::ResultIterator::operator* ( ) const
inlinenoexcept

Returns a reference to the current value.

Definition at line 566 of file Result.hpp.

◆ operator->()

pointer hyperapi::ResultIterator::operator-> ( ) const
inlinenoexcept

Returns a pointer to the current value.

Definition at line 569 of file Result.hpp.


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