search_sort Class Reference

Base class for full text sort objects of search queries. More...

#include <couchbase/search_sort.hxx>

Inheritance diagram for search_sort:

Public Member Functions
virtual	~search_sort ()=default
virtual auto	encode () const -> encoded_search_sort=0

Protected Member Functions
	search_sort ()=default
	search_sort (bool descending)

Protected Attributes
std::optional< bool >	descending_ {}

Detailed Description

Base class for full text sort objects of search queries.

See also

https://docs.couchbase.com/server/current/fts/fts-search-request.html#sorting-with-objects

Since

1.0.0

Constructor & Destructor Documentation

~search_sort()

virtual ~search_sort ( )

virtualdefault

search_sort() [1/2]

search_sort ( )

protecteddefault

search_sort() [2/2]

search_sort ( bool descending )

inlineexplicitprotected

Member Function Documentation

encode()

virtual auto encode ( ) const -> encoded_search_sort

nodiscardpure virtual

Returns

encoded representation of the search facet.

Since

1.0.0

Internal

Internal interface

Implemented in search_sort_field, search_sort_geo_distance, search_sort_id, and search_sort_score.

Member Data Documentation

descending_

std::optional<bool> descending_ {}

protected

---

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

• couchbase/search_sort.hxx