Tkrzw
|
Interface of iterator for each record. More...
#include <tkrzw_dbm.h>
Public Member Functions | |
virtual | ~Iterator ()=default |
Destructor. More... | |
virtual Status | First ()=0 |
Initializes the iterator to indicate the first record. More... | |
virtual Status | Last ()=0 |
Initializes the iterator to indicate the last record. More... | |
virtual Status | Jump (std::string_view key)=0 |
Initializes the iterator to indicate a specific record. More... | |
virtual Status | JumpLower (std::string_view key, bool inclusive=false)=0 |
Initializes the iterator to indicate the last record whose key is lower than a given key. More... | |
virtual Status | JumpUpper (std::string_view key, bool inclusive=false)=0 |
Initializes the iterator to indicate the first record whose key is upper than a given key. More... | |
virtual Status | Next ()=0 |
Moves the iterator to the next record. More... | |
virtual Status | Previous ()=0 |
Moves the iterator to the previous record. More... | |
virtual Status | Process (RecordProcessor *proc, bool writable)=0 |
Processes the current record with a processor. More... | |
virtual Status | Get (std::string *key=nullptr, std::string *value=nullptr) |
Gets the key and the value of the current record of the iterator. More... | |
virtual std::string | GetKey (std::string_view default_value="") |
Gets the key of the current record, in a simple way. More... | |
virtual std::string | GetValue (std::string_view default_value="") |
Gets the value of the current record, in a simple way. More... | |
virtual Status | Set (std::string_view value) |
Sets the value of the current record. More... | |
virtual Status | Remove () |
Removes the current record. More... | |
Interface of iterator for each record.
|
virtualdefault |
Destructor.
Reimplemented in tkrzw::PolyDBM::Iterator, tkrzw::TreeDBM::Iterator, tkrzw::TinyDBM::Iterator, tkrzw::StdTreeDBM::Iterator, tkrzw::StdHashDBM::Iterator, tkrzw::SkipDBM::Iterator, tkrzw::ShardDBM::Iterator, tkrzw::HashDBM::Iterator, tkrzw::CacheDBM::Iterator, and tkrzw::BabyDBM::Iterator.
|
pure virtual |
Initializes the iterator to indicate the first record.
Implemented in tkrzw::TreeDBM::Iterator, tkrzw::TinyDBM::Iterator, tkrzw::StdTreeDBM::Iterator, tkrzw::StdHashDBM::Iterator, tkrzw::SkipDBM::Iterator, tkrzw::ShardDBM::Iterator, tkrzw::PolyDBM::Iterator, tkrzw::HashDBM::Iterator, tkrzw::CacheDBM::Iterator, and tkrzw::BabyDBM::Iterator.
|
pure virtual |
Initializes the iterator to indicate the last record.
Implemented in tkrzw::TreeDBM::Iterator, tkrzw::TinyDBM::Iterator, tkrzw::StdTreeDBM::Iterator, tkrzw::StdHashDBM::Iterator, tkrzw::SkipDBM::Iterator, tkrzw::ShardDBM::Iterator, tkrzw::PolyDBM::Iterator, tkrzw::HashDBM::Iterator, tkrzw::CacheDBM::Iterator, and tkrzw::BabyDBM::Iterator.
|
pure virtual |
Initializes the iterator to indicate a specific record.
key | The key of the record to look for. |
Implemented in tkrzw::TreeDBM::Iterator, tkrzw::TinyDBM::Iterator, tkrzw::StdTreeDBM::Iterator, tkrzw::StdHashDBM::Iterator, tkrzw::SkipDBM::Iterator, tkrzw::ShardDBM::Iterator, tkrzw::PolyDBM::Iterator, tkrzw::HashDBM::Iterator, tkrzw::CacheDBM::Iterator, and tkrzw::BabyDBM::Iterator.
|
pure virtual |
Initializes the iterator to indicate the last record whose key is lower than a given key.
key | The key to compare with. |
inclusive | If true, the considtion is inclusive: equal to or lower than the key. |
Implemented in tkrzw::TreeDBM::Iterator, tkrzw::TinyDBM::Iterator, tkrzw::StdTreeDBM::Iterator, tkrzw::StdHashDBM::Iterator, tkrzw::ShardDBM::Iterator, tkrzw::PolyDBM::Iterator, tkrzw::HashDBM::Iterator, tkrzw::CacheDBM::Iterator, tkrzw::BabyDBM::Iterator, and tkrzw::SkipDBM::Iterator.
|
pure virtual |
Initializes the iterator to indicate the first record whose key is upper than a given key.
key | The key to compare with. |
inclusive | If true, the considtion is inclusive: equal to or upper than the key. |
Implemented in tkrzw::TreeDBM::Iterator, tkrzw::TinyDBM::Iterator, tkrzw::StdTreeDBM::Iterator, tkrzw::StdHashDBM::Iterator, tkrzw::ShardDBM::Iterator, tkrzw::PolyDBM::Iterator, tkrzw::HashDBM::Iterator, tkrzw::CacheDBM::Iterator, tkrzw::BabyDBM::Iterator, and tkrzw::SkipDBM::Iterator.
|
pure virtual |
Moves the iterator to the next record.
Implemented in tkrzw::TreeDBM::Iterator, tkrzw::TinyDBM::Iterator, tkrzw::StdTreeDBM::Iterator, tkrzw::StdHashDBM::Iterator, tkrzw::SkipDBM::Iterator, tkrzw::ShardDBM::Iterator, tkrzw::PolyDBM::Iterator, tkrzw::HashDBM::Iterator, tkrzw::CacheDBM::Iterator, and tkrzw::BabyDBM::Iterator.
|
pure virtual |
Moves the iterator to the previous record.
Implemented in tkrzw::TreeDBM::Iterator, tkrzw::TinyDBM::Iterator, tkrzw::StdTreeDBM::Iterator, tkrzw::StdHashDBM::Iterator, tkrzw::SkipDBM::Iterator, tkrzw::ShardDBM::Iterator, tkrzw::PolyDBM::Iterator, tkrzw::HashDBM::Iterator, tkrzw::CacheDBM::Iterator, and tkrzw::BabyDBM::Iterator.
|
pure virtual |
Processes the current record with a processor.
proc | The pointer to the processor object. |
writable | True if the processor can edit the record. |
Implemented in tkrzw::TreeDBM::Iterator, tkrzw::TinyDBM::Iterator, tkrzw::StdTreeDBM::Iterator, tkrzw::StdHashDBM::Iterator, tkrzw::SkipDBM::Iterator, tkrzw::ShardDBM::Iterator, tkrzw::PolyDBM::Iterator, tkrzw::HashDBM::Iterator, tkrzw::CacheDBM::Iterator, and tkrzw::BabyDBM::Iterator.
|
virtual |
Gets the key and the value of the current record of the iterator.
key | The pointer to a string object to contain the record key. If it is nullptr, the key data is ignored. |
value | The pointer to a string object to contain the record value. If it is nullptr, the value data is ignored. |
Reimplemented in tkrzw::SkipDBM::Iterator, tkrzw::ShardDBM::Iterator, and tkrzw::PolyDBM::Iterator.
|
virtual |
Gets the key of the current record, in a simple way.
default_value | The value to be returned on failure. |
|
virtual |
Gets the value of the current record, in a simple way.
default_value | The value to be returned on failure. |
|
virtual |
Sets the value of the current record.
value | The value of the record. |
Reimplemented in tkrzw::ShardDBM::Iterator, and tkrzw::PolyDBM::Iterator.
|
virtual |
Removes the current record.
Reimplemented in tkrzw::ShardDBM::Iterator, and tkrzw::PolyDBM::Iterator.