Represents result of lookup_in_replica operations. More...

#include <couchbase/lookup_in_replica_result.hxx>

Inheritance diagram for lookup_in_replica_result:

Public Member Functions
	lookup_in_replica_result ()=default
	lookup_in_replica_result (couchbase::cas cas, std::vector< entry > entries, bool is_deleted, bool is_replica)
	Constructs result for lookup_in_replica operation.
auto	is_replica () const -> bool
	Returns whether this document originates from a replica node.
Public Member Functions inherited from lookup_in_result
	lookup_in_result ()=default
	lookup_in_result (couchbase::cas cas, std::vector< entry > entries, bool is_deleted)
	Constructs result for lookup_in_result operation.
template<typename Document, typename Serializer = codec::tao_json_serializer, std::enable_if_t< codec::is_serializer_v< Serializer >, bool > = true>
auto	content_as (std::size_t index) const -> Document
	Decodes field of the document into type.
template<typename Document, typename Serializer = codec::tao_json_serializer, std::enable_if_t< codec::is_serializer_v< Serializer >, bool > = true>
auto	content_as (const std::string &path) const -> Document
	Decodes field of the document into type.
template<typename Document, typename Serializer = codec::tao_json_serializer, std::enable_if_t< codec::is_serializer_v< Serializer >, bool > = true>
auto	content_as (subdoc::lookup_in_macro macro) const -> Document
	Decodes field of the document into type.
auto	exists (std::size_t index) const -> bool
	Allows to check if a value at the given index exists.
auto	exists (subdoc::lookup_in_macro macro) const -> bool
	Allows to check if a value at the given index exists.
auto	exists (const std::string &path) const -> bool
	Allows to check if a value at the given index exists.
auto	is_deleted () const -> bool
	Returns whether this document was deleted (a tombstone).
auto	has_value (std::size_t index) const -> bool
	Returns whether the field has value.
auto	has_value (const std::string &path) const -> bool
	Returns whether the field has value.
Public Member Functions inherited from result
	result ()=default
	result (couchbase::cas cas)
auto	cas () const -> couchbase::cas

Detailed Description

Represents result of lookup_in_replica operations.

Since: 1.0.0

Committed: Generally available API and should be preferred in production

Constructor & Destructor Documentation

◆ lookup_in_replica_result() [1/2]

lookup_in_replica_result ( )

default

Since: 1.0.0

Internal: Internal interface

◆ lookup_in_replica_result() [2/2]

lookup_in_replica_result	(	couchbase::cas	cas,
		std::vector< entry >	entries,
		bool	is_deleted,
		bool	is_replica )

inline

Constructs result for lookup_in_replica operation.

Parameters

cas
entries	list of the fields returned by the server
is_deleted
is_replica	true if document originates from replica node

Since: 1.0.0

Committed: Generally available API and should be preferred in production

Member Function Documentation

◆ is_replica()

auto is_replica ( ) const -> bool

inlinenodiscard

Returns whether this document originates from a replica node.

Returns: whether document originates from a replica node

Since: 1.0.0

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

couchbase/lookup_in_replica_result.hxx