Couchbase C++ SDK 1.0.2 (rev. 51f4775)
Loading...
Searching...
No Matches
range_scan Struct Reference

A range scan performs a scan on a range of keys. More...

#include <couchbase/scan_type.hxx>

Inheritance diagram for range_scan:
Inheritance graph

Public Member Functions

 range_scan ()=default
 Creates an instance of a range scan type with no bounds.
 
 range_scan (std::optional< scan_term > from, std::optional< scan_term > to)
 Creates an instance of a range scan type.
 
auto from (scan_term from) -> range_scan &
 Specifies the lower bound of the range.
 
auto to (scan_term to) -> range_scan &
 Specifies the upper bound of the range.
 
auto build () const -> built override
 Returns the range scan type as an immutable value.
 
- Public Member Functions inherited from scan_type
virtual ~scan_type ()=default
 

Detailed Description

A range scan performs a scan on a range of keys.

Since
1.0.0
Committed
Generally available API and should be preferred in production

Constructor & Destructor Documentation

◆ range_scan() [1/2]

range_scan ( )
default

Creates an instance of a range scan type with no bounds.

Since
1.0.0
Committed
Generally available API and should be preferred in production

◆ range_scan() [2/2]

range_scan ( std::optional< scan_term > from,
std::optional< scan_term > to )
inline

Creates an instance of a range scan type.

Parameters
fromthe scan term representing the lower bound of the range, optional.
tothe scan term representing the upper bound of the range, optional.
Since
1.0.0
Committed
Generally available API and should be preferred in production

Member Function Documentation

◆ build()

auto build ( ) const -> built
inlinenodiscardoverridevirtual

Returns the range scan type as an immutable value.

Returns
scan type as an immutable value.
Since
1.0.0
Internal
Internal interface

Implements scan_type.

◆ from()

auto from ( scan_term from) -> range_scan&
inline

Specifies the lower bound of the range.

Parameters
fromscan term representing the lower bound.
Returns
the range scan object for chaining purposes.
Since
1.0.0
Committed
Generally available API and should be preferred in production

◆ to()

auto to ( scan_term to) -> range_scan&
inline

Specifies the upper bound of the range.

Parameters
toscan term representing the upper bound.
Returns
the range scan object for chaining purposes.
Since
1.0.0
Committed
Generally available API and should be preferred in production

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