Skip to content
RU

Struct mdbx::pair_result

ClassList > mdbx > pair_result

Combines pair of slices for key and value with boolean flag to represent result of certain operations.

  • #include <mdbx.h++>

Inherits the following classes: mdbx::pair

Inherited by the following classes: mdbx::cursor::move_result

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
bool done
true when the operation has found/produced the pair.

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
pair_result & operator= (const pair_result &) noexcept
Copy assignment operator.
constexpr pair_result () noexcept
Constructs an empty (not done) result with an invalid pair.
constexpr pair_result (const slice & key, const slice & value, bool done) noexcept
Constructs the result.
pair_result (const pair_result &) noexcept
Copy constructor.

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 done

true when the operation has found/produced the pair.

bool mdbx::pair_result::done;

Public Functions Documentation

function operator=

Copy assignment operator. 

pair_result & mdbx::pair_result::operator= (
    const pair_result &
) noexcept

Returns:

A reference to this instance.

function pair_result [1/3]

Constructs an empty (not done) result with an invalid pair. 

inline constexpr mdbx::pair_result::pair_result () noexcept

function pair_result [2/3]

Constructs the result. 

inline constexpr mdbx::pair_result::pair_result (
    const slice & key,
    const slice & value,
    bool done
) noexcept

Parameters:

  • key The key part.
  • value The value part.
  • done true when the operation has found/produced the pair.

function pair_result [3/3]

Copy constructor. 

mdbx::pair_result::pair_result (
    const pair_result &
) noexcept

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