Skip to content

Struct mdbx::cursor::estimate_result

ClassList > mdbx > cursor > estimate_result

The result of a range estimation: the boundary key-value pair plus the approximate number of items.

  • #include <mdbx.h++>

Inherits the following classes: mdbx::pair

Public Types inherited from mdbx::pair

See mdbx::pair

Type Name
typedef std::pair< slice, slice > stl_pair
An alias for std::pair< slice , slice > .

Public Attributes

Type Name
ptrdiff_t approximate_quantity
The approximate number of items in the range.

Public Attributes inherited from mdbx::pair

See mdbx::pair

Type Name
slice key
The key part of the pair.
slice value
The value part of the pair.

Public Functions

Type Name
estimate_result (const cursor & cursor, move_operation operation)
Estimates the number of items from the current position per the given operation.
estimate_result (const cursor & cursor, move_operation operation, const slice & key)
Estimates the number of items from the given key per the given operation.
estimate_result (const estimate_result &) noexcept
Copy constructor.
estimate_result & operator= (const estimate_result &) noexcept
Copy assignment operator.

Public Functions inherited from mdbx::pair

See mdbx::pair

Type Name
constexpr operator stl_pair () noexcept const
Converts the pair to a std::pair of slices.
pair & operator= (const pair &) noexcept
Copy assignment operator.
pair & operator= (pair && couple) noexcept
Move assignment operator.
pair & operator= (const stl_pair & couple)
Assigns the pair from a std::pair of slices.
pair & operator= (stl_pair && couple)
Move-assigns the pair from a temporary std::pair of slices.
constexpr pair (const slice & key, const slice & value) noexcept
Constructs the pair from the given key and value slices.
constexpr pair (const stl_pair & couple) noexcept
Constructs the pair from a std::pair of slices.
pair (const pair &) noexcept
Copy constructor.

Public Static Functions inherited from mdbx::pair

See mdbx::pair

Type Name
pair invalid () noexcept
Builds an invalid pair of invalid slices.

Public Attributes Documentation

variable approximate_quantity

The approximate number of items in the range.

ptrdiff_t mdbx::cursor::estimate_result::approximate_quantity;

Public Functions Documentation

function estimate_result [1/3]

Estimates the number of items from the current position per the given operation.

inline mdbx::cursor::estimate_result::estimate_result (
    const cursor & cursor,
    move_operation operation
) 

Parameters:

  • cursor The positioned cursor.
  • operation The positioning operation.

function estimate_result [2/3]

Estimates the number of items from the given key per the given operation.

inline mdbx::cursor::estimate_result::estimate_result (
    const cursor & cursor,
    move_operation operation,
    const slice & key
) 

Parameters:

  • cursor The positioned cursor.
  • operation The positioning operation.
  • key The boundary key.

function estimate_result [3/3]

Copy constructor.

mdbx::cursor::estimate_result::estimate_result (
    const estimate_result &
) noexcept

function operator=

Copy assignment operator.

estimate_result & mdbx::cursor::estimate_result::operator= (
    const estimate_result &
) noexcept

Returns:

A reference to this instance.



The documentation for this class was generated from the following file mdbx.h++