Skip to content

sgns::storage::face::MapCursor

An abstraction over generic map cursor. More...

#include <map_cursor.hpp>

Public Functions

Name
virtual ~MapCursor() =default
virtual outcome::result< void > seekToFirst() =0
Same as std::begin(...);.
virtual outcome::result< void > seek(const K & key) =0
Find given key and seek iterator to this key.
virtual outcome::result< void > seekToLast() =0
Same as std::rbegin(...);, e.g. points to the last valid element.
virtual bool isValid() const =0
Is iterator valid?
virtual outcome::result< void > next() =0
Make step forward.
virtual outcome::result< void > prev() =0
Make step backwards.
virtual outcome::result< K > key() const =0
Getter for key.
virtual outcome::result< V > value() const =0
Getter for value.

Detailed Description

template <typename K ,
typename V >
struct sgns::storage::face::MapCursor;

An abstraction over generic map cursor.

Template Parameters:

  • K key type
  • V value type

Public Functions Documentation

function ~MapCursor

virtual ~MapCursor() =default

function seekToFirst

virtual outcome::result< void > seekToFirst() =0

Same as std::begin(...);.

Reimplemented by: sgns::storage::rocksdb::Cursor::seekToFirst, sgns::storage::trie::SuperGeniusTrieCursor::seekToFirst

function seek

virtual outcome::result< void > seek(
    const K & key
) =0

Find given key and seek iterator to this key.

Reimplemented by: sgns::storage::rocksdb::Cursor::seek, sgns::storage::trie::SuperGeniusTrieCursor::seek

function seekToLast

virtual outcome::result< void > seekToLast() =0

Same as std::rbegin(...);, e.g. points to the last valid element.

Reimplemented by: sgns::storage::rocksdb::Cursor::seekToLast, sgns::storage::trie::SuperGeniusTrieCursor::seekToLast

function isValid

virtual bool isValid() const =0

Is iterator valid?

Return: true if iterator points to the element of map, false otherwise

Reimplemented by: sgns::storage::rocksdb::Cursor::isValid, sgns::storage::trie::SuperGeniusTrieCursor::isValid

function next

virtual outcome::result< void > next() =0

Make step forward.

Reimplemented by: sgns::storage::rocksdb::Cursor::next, sgns::storage::trie::SuperGeniusTrieCursor::next

function prev

virtual outcome::result< void > prev() =0

Make step backwards.

Reimplemented by: sgns::storage::rocksdb::Cursor::prev, sgns::storage::trie::SuperGeniusTrieCursor::prev

function key

virtual outcome::result< K > key() const =0

Getter for key.

Return: key

Reimplemented by: sgns::storage::rocksdb::Cursor::key, sgns::storage::trie::SuperGeniusTrieCursor::key

function value

virtual outcome::result< V > value() const =0

Getter for value.

Return: value

Reimplemented by: sgns::storage::rocksdb::Cursor::value, sgns::storage::trie::SuperGeniusTrieCursor::value


Updated on 2026-04-15 at 11:00:39 -0700