scan_term Struct Reference

A scan term used to specify the bounds of a range scan operation. More...

#include <couchbase/scan_type.hxx>

Classes
struct	built
	Immutable value representing the scan term. More...

Public Member Functions
	scan_term (std::string term)
	Constructs an instance representing the scan term for the given term.
auto	exclusive (bool exclusive) -> scan_term &
	Specifies whether this term is excluded from the scan results.
auto	build () const -> built
	Returns the scan term as an immutable value.

Detailed Description

A scan term used to specify the bounds of a range scan operation.

Since

1.0.0

Committed

Generally available API and should be preferred in production

Constructor & Destructor Documentation

scan_term()

scan_term ( std::string term )

inlineexplicit

Constructs an instance representing the scan term for the given term.

Parameters

term	the string representation of the term.

Since

1.0.0

Committed

Generally available API and should be preferred in production

Member Function Documentation

build()

auto build ( ) const -> built

inlinenodiscard

Returns the scan term as an immutable value.

Returns

scan term as an immutable value.

Since

1.0.0

Internal

Internal interface

exclusive()

auto exclusive ( bool exclusive ) -> scan_term&

inline

Specifies whether this term is excluded from the scan results.

The bounds are included by default.

Parameters

exclusive

whether the term should be excluded.

Returns

the scan term object for chaining purposes.

---

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

• couchbase/scan_type.hxx