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

A chunk of a result. More...

#include <Result.hpp>

Public Member Functions

 Chunk () noexcept=default
 Constructor, constructs a closed chunk.
 
 ~Chunk () noexcept
 Destructor.
 
 Chunk (Chunk &other)=delete
 Copy constructor.
 
Chunkoperator= (Chunk &other)=delete
 Copy assignment.
 
 Chunk (Chunk &&other) noexcept
 Move constructor.
 
Chunkoperator= (Chunk &&other) noexcept
 Move assignment.
 
Row getRowAt (hyper_row_index_t chunkRowIndex) const noexcept
 Retrieves the row at the given index inside the chunk (starting at 0).
 
size_t getRowCount () const noexcept
 
bool isOpen () const noexcept
 Returns whether the chunk is valid.
 
 operator bool () const noexcept
 Returns whether the chunk is valid.
 

Detailed Description

A chunk of a result.

A chunk is a collection of rows.

Definition at line 128 of file Result.hpp.

Constructor & Destructor Documentation

◆ Chunk()

hyperapi::Chunk::Chunk ( )
defaultnoexcept

Constructor, constructs a closed chunk.

Postcondition
!isOpen()

Member Function Documentation

◆ getRowAt()

Row hyperapi::Chunk::getRowAt ( hyper_row_index_t  chunkRowIndex) const
noexcept

Retrieves the row at the given index inside the chunk (starting at 0).

Parameters
chunkRowIndexThe index of the row inside the chunk.
Returns
The row at given index.
Precondition
isOpen()

◆ getRowCount()

size_t hyperapi::Chunk::getRowCount ( ) const
inlinenoexcept
Returns
The number of rows inside the chunk.
Precondition
isOpen()

Definition at line 160 of file Result.hpp.

◆ isOpen()

bool hyperapi::Chunk::isOpen ( ) const
inlinenoexcept

Returns whether the chunk is valid.

Definition at line 163 of file Result.hpp.

◆ operator bool()

hyperapi::Chunk::operator bool ( ) const
inlinenoexcept

Returns whether the chunk is valid.

Definition at line 166 of file Result.hpp.


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