floo::BMXResultPage#

Paged result More...

#include <bmx_result_page.h>

Inherits from BMXBaseObject

Public Functions#

	Name
	BMXResultPage() Constructor
	BMXResultPage(const std::vector< T > & result, int64_t offset) Constructor
	BMXResultPage(const std::vector< T > & result, std::string cursor) Constructor
	BMXResultPage(const BMXResultPage & from) Constructor
	BMXResultPage(BMXResultPage && from) Constructor
BMXResultPage &	operator=(const BMXResultPage & from) Assignment function
virtual	~BMXResultPage() Destructor
size_t	count() const Size of vector object-array
int64_t	offset() const Offset
const std::string &	cursor() const cursor offset
const std::vector< T > &	result() const vector object-array

Detailed Description#

template <typename T >
class floo::BMXResultPage;

Paged result

Public Functions Documentation#

function BMXResultPage#

inline BMXResultPage()

Constructor

Example:

{% lanying_code_snippet repo="lanying-im-embedded",class="BMXResultPage",function="BMXResultPage" %}{% endlanying_code_snippet %}

function BMXResultPage#

inline BMXResultPage(
    const std::vector< T > & result,
    int64_t offset
)

Constructor

Parameters:

result List data
offset Offset

Example:

{% lanying_code_snippet repo="lanying-im-embedded",class="BMXResultPage",function="BMXResultPage" %}{% endlanying_code_snippet %}

function BMXResultPage#

inline BMXResultPage(
    const std::vector< T > & result,
    std::string cursor
)

Constructor

Parameters:

result List result
cursor cursor offset

Example:

{% lanying_code_snippet repo="lanying-im-embedded",class="BMXResultPage",function="BMXResultPage" %}{% endlanying_code_snippet %}

function BMXResultPage#

inline BMXResultPage(
    const BMXResultPage & from
)

Constructor

Parameters:

from BMXResultPage object

Example:

{% lanying_code_snippet repo="lanying-im-embedded",class="BMXResultPage",function="BMXResultPage" %}{% endlanying_code_snippet %}

function BMXResultPage#

inline BMXResultPage(
    BMXResultPage && from
)

Constructor

Parameters:

from BMXResultPage object

Example:

{% lanying_code_snippet repo="lanying-im-embedded",class="BMXResultPage",function="BMXResultPage" %}{% endlanying_code_snippet %}

function operator=#

inline BMXResultPage & operator=(
    const BMXResultPage & from
)

Assignment function

Parameters:

from BMXResultPage object

Return: BMXResultPage

Example:

{% lanying_code_snippet repo="lanying-im-embedded",class="BMXResultPage",function="operator=" %}{% endlanying_code_snippet %}

function ~BMXResultPage#

inline virtual ~BMXResultPage()

Destructor

Example:

{% lanying_code_snippet repo="lanying-im-embedded",class="BMXResultPage",function="~BMXResultPage" %}{% endlanying_code_snippet %}

function count#

inline size_t count() const

Size of vector object-array

Return: size_t

Example:

{% lanying_code_snippet repo="lanying-im-embedded",class="BMXResultPage",function="count" %}{% endlanying_code_snippet %}

function offset#

inline int64_t offset() const

Offset

Return: int64_t

Example:

{% lanying_code_snippet repo="lanying-im-embedded",class="BMXResultPage",function="offset" %}{% endlanying_code_snippet %}

function cursor#

inline const std::string & cursor() const

cursor offset

Return: std::string

Example:

{% lanying_code_snippet repo="lanying-im-embedded",class="BMXResultPage",function="cursor" %}{% endlanying_code_snippet %}

function result#

inline const std::vector< T > & result() const

vector object-array

Return: std::vector<T>

Example:

{% lanying_code_snippet repo="lanying-im-embedded",class="BMXResultPage",function="result" %}{% endlanying_code_snippet %}

Updated on 2022-01-26 at 17:20:40 +0800