Skip to content

Struct mdbx::cursor::move_result

ClassList > mdbx > cursor > move_result

The result of a cursor move/seek operation: the found key-value pair plus the success flag.

  • #include <mdbx.h++>

Inherits the following classes: mdbx::pair_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 inherited from mdbx::pair_result

See mdbx::pair_result

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
move_result (cursor & cursor, move_operation operation, bool throw_notfound)
Performs the given positioning operation.
move_result (cursor & cursor, move_operation operation, const slice & key, bool throw_notfound)
Performs the given positioning operation at the specified key.
move_result (const move_result &) noexcept
Copy constructor.
move_result & operator= (const move_result &) noexcept
Copy assignment operator.

Public Functions inherited from mdbx::pair_result

See mdbx::pair_result

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 Functions Documentation

function move_result [1/3]

Performs the given positioning operation.

inline mdbx::cursor::move_result::move_result (
    cursor & cursor,
    move_operation operation,
    bool throw_notfound
) 

Parameters:

  • cursor The cursor to be moved.
  • operation The positioning operation.
  • throw_notfound Throw mdbx::not_found instead of returning an unsuccessful result.

function move_result [2/3]

Performs the given positioning operation at the specified key.

inline mdbx::cursor::move_result::move_result (
    cursor & cursor,
    move_operation operation,
    const slice & key,
    bool throw_notfound
) 

Parameters:

  • cursor The cursor to be moved.
  • operation The positioning operation.
  • key The key to position at.
  • throw_notfound Throw mdbx::not_found instead of returning an unsuccessful result.

function move_result [3/3]

Copy constructor.

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

function operator=

Copy assignment operator.

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

Returns:

A reference to this instance.



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