Class mdbx::cursor_managed
ClassList > mdbx > cursor_managed
Managed cursor. More...
#include <mdbx.h++>
Inherits the following classes: mdbx::cursor
Public Types inherited from mdbx::cursor
See mdbx::cursor
| Type | Name |
|---|---|
| enum | bunch_delete Modes for deleting bunches of neighboring items, see MDBX_bunch_action_t() . The EXCLUDING and INCLUDING suffixes mean correspondingly excluding and including deletion items in the current cursor position. |
| enum | move_operation |
Public Functions
| Type | Name |
|---|---|
| void | close () Explicitly closes the cursor. |
| cursor_managed (void * your_context=nullptr) Creates a new managed cursor with underlying object. |
|
| cursor_managed (cursor_managed &&) = default |
|
| cursor_managed (const cursor_managed &) = delete |
|
| cursor_managed & | operator= (cursor_managed && other) noexcept |
| cursor_managed & | operator= (const cursor_managed &) = delete |
| MDBX_cursor * | withdraw_handle () noexcept |
| ~cursor_managed () |
Public Functions inherited from mdbx::cursor
See mdbx::cursor
| Type | Name |
|---|---|
| cursor_managed | clone (void * your_context=nullptr) const |
| move_result | current (bool throw_notfound=true) const |
| constexpr | cursor () noexcept |
| cursor (const cursor &) noexcept |
|
| ptrdiff_t | distance_from (const cursor from, unsigned deepness=42) const |
| ptrdiff_t | distance_from_first (unsigned deepness=42) const |
| ptrdiff_t | distance_to (const cursor to, unsigned deepness=42) const |
| ptrdiff_t | distance_to_end (unsigned deepness=42) const |
| bool | fullscan (CALLABLE_PREDICATE predicate, bool backward=false) |
| move_result | get_multiple_samelength (bool throw_notfound=false) |
| const MDBX_cursor * | handle () noexcept const |
| MDBX_cursor * | handle () noexcept |
| void | insert (const pair & kv) |
| bool | is_after_than (const cursor & other, bool ignore_nested=false) const |
| bool | is_before_than (const cursor & other, bool ignore_nested=false) const |
| bool | is_same_or_after_than (const cursor & other, bool ignore_nested=false) const |
| bool | is_same_or_before_than (const cursor & other, bool ignore_nested=false) const |
| bool | is_same_position (const cursor & other, bool ignore_nested=false) const |
| move_result | move (move_operation operation, bool throw_notfound) |
| move_result | move (move_operation operation, const slice & key, bool throw_notfound) |
| move_result | move (move_operation operation, const slice & key, const slice & value, bool throw_notfound) |
| bool | move (move_operation operation, slice & key, slice & value, bool throw_notfound) |
| move_result | next_multiple_samelength (bool throw_notfound=false) |
| constexpr | operator MDBX_cursor * () noexcept |
| constexpr | operator const MDBX_cursor * () noexcept const |
| map_handle () const |
|
| txn () const |
|
| cursor & | operator= (const cursor &) noexcept |
| move_result | previous_multiple_samelength (bool throw_notfound=false) |
| void | put (const pair & kv, put_mode mode) |
| size_t | put_multiple_samelength (const slice & key, const VALUE * values_array, size_t values_count, put_mode mode, bool allow_partial=false) |
| void | put_multiple_samelength (const slice & key, const ::std::vector< VALUE > & vector, put_mode mode) |
| slice | reserve_current (size_t value_length) Reserves and returns the space for storing a value associated with a key at the current cursor position. |
| slice | reverse_current (size_t value_length) Deprecated misspelling of reserve_current() . |
| bool | scan_until (CALLABLE_PREDICATE predicate, move_operation start=first, move_operation turn=next) |
| bool | scan_until_from (CALLABLE_PREDICATE predicate, slice & from, move_operation start=key_greater_or_equal, move_operation turn=next) |
| bool | scan_until_from (CALLABLE_PREDICATE predicate, pair & from, move_operation start=pair_greater_or_equal, move_operation turn=next) |
| move_result | seek_multiple_samelength (const slice & key, bool throw_notfound=true) |
| move_result | to_current_first_multi (bool throw_notfound=true) |
| move_result | to_current_last_multi (bool throw_notfound=true) |
| move_result | to_current_next_multi (bool throw_notfound=true) |
| move_result | to_current_prev_multi (bool throw_notfound=true) |
| move_result | to_exact_key_value_equal (const slice & key, const slice & value, bool throw_notfound=true) |
| move_result | to_exact_key_value_greater_or_equal (const slice & key, const slice & value, bool throw_notfound=true) |
| move_result | to_exact_key_value_greater_than (const slice & key, const slice & value, bool throw_notfound=true) |
| move_result | to_exact_key_value_lesser_or_equal (const slice & key, const slice & value, bool throw_notfound=true) |
| move_result | to_exact_key_value_lesser_than (const slice & key, const slice & value, bool throw_notfound=true) |
| move_result | to_first (bool throw_notfound=true) |
| move_result | to_key_equal (const slice & key, bool throw_notfound=true) |
| move_result | to_key_exact (const slice & key, bool throw_notfound=true) |
| move_result | to_key_greater_or_equal (const slice & key, bool throw_notfound=true) |
| move_result | to_key_greater_than (const slice & key, bool throw_notfound=true) |
| move_result | to_key_lesser_or_equal (const slice & key, bool throw_notfound=true) |
| move_result | to_key_lesser_than (const slice & key, bool throw_notfound=true) |
| move_result | to_last (bool throw_notfound=true) |
| move_result | to_next (bool throw_notfound=true) |
| move_result | to_next_first_multi (bool throw_notfound=true) |
| move_result | to_pair_equal (const slice & key, const slice & value, bool throw_notfound=true) |
| move_result | to_pair_exact (const slice & key, const slice & value, bool throw_notfound=true) |
| move_result | to_pair_greater_or_equal (const slice & key, const slice & value, bool throw_notfound=true) |
| move_result | to_pair_greater_than (const slice & key, const slice & value, bool throw_notfound=true) |
| move_result | to_pair_lesser_or_equal (const slice & key, const slice & value, bool throw_notfound=true) |
| move_result | to_pair_lesser_than (const slice & key, const slice & value, bool throw_notfound=true) |
| move_result | to_previous (bool throw_notfound=true) |
| move_result | to_previous_last_multi (bool throw_notfound=true) |
| value_result | try_insert (const pair & kv) |
| void | update_current (const slice & value) Updates value associated with a key at the current cursor position. |
| void | upsert (const pair & kv) |
Protected Attributes inherited from mdbx::cursor
See mdbx::cursor
| Type | Name |
|---|---|
| MDBX_cursor * | handle_ = {nullptr} |
Detailed Description
As other managed classes, cursor_managed destroys the represented underlying object from the own class destructor, but disallows copying and assignment for instances.
See also: mdbx_cursor_create()
See also: mdbx_cursor_bind()
See also: mdbx_cursor_close()
Public Functions Documentation
function close
Explicitly closes the cursor.
void mdbx::cursor_managed::close ()
function cursor_managed [2/4]
Creates a new managed cursor with underlying object.
inline mdbx::cursor_managed::cursor_managed (
void * your_context=nullptr
)
function cursor_managed [3/4]
mdbx::cursor_managed::cursor_managed (
cursor_managed &&
) = default
function cursor_managed [4/4]
mdbx::cursor_managed::cursor_managed (
const cursor_managed &
) = delete
function operator=
cursor_managed & mdbx::cursor_managed::operator= (
cursor_managed && other
) noexcept
function operator=
cursor_managed & mdbx::cursor_managed::operator= (
const cursor_managed &
) = delete
function withdraw_handle
inline MDBX_cursor * mdbx::cursor_managed::withdraw_handle () noexcept
function ~cursor_managed
mdbx::cursor_managed::~cursor_managed ()
The documentation for this class was generated from the following file docs/mdbx.h++