Skip to content

Latest commit

 

History

History
35 lines (29 loc) · 1.57 KB

README.md

File metadata and controls

35 lines (29 loc) · 1.57 KB

bIter

Go Report Card PkgGoDev Maintainability codecov GitHub License

Iterator for badgerDB

// Iterator adds an implementable target for variations of different Iterator's
// for simplification of functional code, that you can then implement this reduced
// interface such that primarily methods Rewind and Valid and Next are overloaded.
// usage:
// 		for iterator.Rewind(); iterator.Valid(); iterator.Next() {
//			iterator.Item()
//			...
//		}
// this is a general snippet of code that using this interface may have overloaded
// only Rewind and Valid are changes
type Iterator interface {
	Rewind()
	Valid() bool
	Next()
	Item() *badger.Item
}

This library also add 5 concrete iterators: prefix, from-to, from, to, prefix-from.

The library does not support backward key-scan (whence only a prefix-from)

Use the method biter.KeyRangeIterator and throw any combination of prefix, from and to at it to get the corresponding Iterator.

for some examples of functionality refer to queries_test.go