TrueCloudLab/neoneo-go
7
0
Fork 2
Code Issues Pull requests Projects Releases Packages Wiki Activity

core: adjust the documentation of SeekRange's Prefix field

Browse source 
It is used in different context (seeking through the storage or
through the contract storage), and sometimes empty prefix is not
supported.
This commit is contained in:
Anna Shaleva 2023-02-18 21:06:30 +03:00
parent 1bdd62702c
commit 09186127da
1 changed files with 4 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
pkg/core/storage/store.go
View file

@ -49,7 +49,9 @@ const (
// SeekRange represents options for Store.Seek operation. // SeekRange represents options for Store.Seek operation.
type SeekRange struct { type SeekRange struct {
// Prefix denotes the Seek's lookup key. // Prefix denotes the Seek's lookup key.
// Empty Prefix is not supported. // If used directly with MemCachedStore's or MemoryStore's Seek, SeekAsync or
// SeekGC empty Prefix is not supported due to internal MemoryStore cache
// architecture; otherwise empty prefix can be used safely.
Prefix []byte Prefix []byte
// Start denotes value appended to the Prefix to start Seek from. // Start denotes value appended to the Prefix to start Seek from.
// Seeking starting from some key includes this key to the result; // Seeking starting from some key includes this key to the result;
@ -57,7 +59,7 @@ type SeekRange struct {
// Start may be empty. Empty Start means seeking through all keys in // Start may be empty. Empty Start means seeking through all keys in
// the DB with matching Prefix. // the DB with matching Prefix.
// Empty Prefix and empty Start can be combined, which means seeking // Empty Prefix and empty Start can be combined, which means seeking
// through all keys in the DB. // through all keys in the DB, but see the Prefix's comment.
Start []byte Start []byte
// Backwards denotes whether Seek direction should be reversed, i.e. // Backwards denotes whether Seek direction should be reversed, i.e.
// whether seeking should be performed in a descending way. // whether seeking should be performed in a descending way.