#include <couchbase/scan_result.hxx>

Classes
class	iterator
	An iterator that can be used to iterate through all the `scan_result_item`s. More...

Public Member Functions
	scan_result ()=default
	Constructs an empty scan result.

	scan_result (std::shared_ptr< internal_scan_result > internal)
	Constructs a scan result from an internal scan result.

void	next (scan_item_handler &&handler) const
	Fetches the next scan result item.

auto	next () const -> std::future< std::pair< error, std::optional< scan_result_item > > >
	Fetches the next scan result item.

void	cancel ()
	Cancels the scan.

auto	begin () -> iterator
	Returns an iterator to the beginning.

auto	end () -> iterator
	Returns an iterator to the end.

Constructor & Destructor Documentation

◆ scan_result() [1/2]

scan_result ( )

default

Constructs an empty scan result.

Since: 1.0.0

Internal: Internal interface

◆ scan_result() [2/2]

scan_result ( std::shared_ptr< internal_scan_result > internal )

explicit

Constructs a scan result from an internal scan result.

Parameters

internal the internal scan result

Since: 1.0.0

Internal: Internal interface

Member Function Documentation

◆ begin()

auto begin ( ) -> iterator

Returns an iterator to the beginning.

Returns: iterator to the beginning

Since: 1.0.0

Volatile: Should not be used in production

◆ cancel()

void cancel ( )

Cancels the scan.

Since: 1.0.0

Volatile: Should not be used in production

◆ end()

auto end ( ) -> iterator

Returns an iterator to the end.

Returns: iterator to the end

Since: 1.0.0

Volatile: Should not be used in production

◆ next() [1/2]

auto next ( ) const -> std::future< std::pair< error, std::optional< scan_result_item > > >

Fetches the next scan result item.

Returns: future object that carries the result of the operation

Since: 1.0.0

Volatile: Should not be used in production

◆ next() [2/2]

void next ( scan_item_handler && handler ) const