mirror of
https://github.com/kaspanet/kaspad.git
synced 2025-06-24 23:12:31 +00:00
7609c50641
* [NOD-885] Create database.Key type * [NOD-885] Rename FullKey()->FullKeyBytes() and Key()->KeyBytes() * [NOD-885] Make Key.String return a hex string * [NOD-885] Rename key parts * [NOD-885] Rename separator->bucketSeparator * [NOD-885] Rename SuffixBytes->Suffix and PrefixBytes->Prefix * [NOD-885] Change comments * [NOD-885] Change key prefix to bucket * [NOD-885] Don't use database.NewKey inside dbaccess * [NOD-885] Fix nil bug in Bucket.Path() * [NOD-885] Rename helpers.go -> keys.go * [NOD-885] Unexport database.NewKey * [NOD-885] Remove redundant code in Bucket.Path()
32 lines
1.2 KiB
Go
32 lines
1.2 KiB
Go
package database
|
|
|
|
// Cursor iterates over database entries given some bucket.
|
|
type Cursor interface {
|
|
// Next moves the iterator to the next key/value pair. It returns whether the
|
|
// iterator is exhausted. Returns false if the cursor is closed.
|
|
Next() bool
|
|
|
|
// First moves the iterator to the first key/value pair. It returns false if
|
|
// such a pair does not exist or if the cursor is closed.
|
|
First() bool
|
|
|
|
// Seek moves the iterator to the first key/value pair whose key is greater
|
|
// than or equal to the given key. It returns ErrNotFound if such pair does not
|
|
// exist.
|
|
Seek(key *Key) error
|
|
|
|
// Key returns the key of the current key/value pair, or ErrNotFound if done.
|
|
// Note that the key is trimmed to not include the prefix the cursor was opened
|
|
// with. The caller should not modify the contents of the returned slice, and
|
|
// its contents may change on the next call to Next.
|
|
Key() (*Key, error)
|
|
|
|
// Value returns the value of the current key/value pair, or ErrNotFound if done.
|
|
// The caller should not modify the contents of the returned slice, and its
|
|
// contents may change on the next call to Next.
|
|
Value() ([]byte, error)
|
|
|
|
// Close releases associated resources.
|
|
Close() error
|
|
}
|