package skl

Import Path
	github.com/dgraph-io/badger/v4/skl (on go.dev)

Dependency Relation
	imports 5 packages, and imported by one package

Involved Source Files

	    arena.go
	    skl.go
Package-Level Type Names (total 4)

	/* sort by: alphabet | popularity */
	 type Arena (struct)
		Arena should be lock-free.

	 type Iterator (struct)
		Iterator is an iterator over skiplist object. For new objects, you just
		need to initialize Iterator.list.

		Methods (total 11)
			(*Iterator) Close() error
				Close frees the resources held by the iterator

			(*Iterator) Key() []byte
				Key returns the key at the current position.

			(*Iterator) Next()
				Next advances to the next position.

			(*Iterator) Prev()
				Prev advances to the previous position.

			(*Iterator) Seek(target []byte)
				Seek advances to the first entry with a key >= target.

			(*Iterator) SeekForPrev(target []byte)
				SeekForPrev finds an entry with key <= target.

			(*Iterator) SeekToFirst()
				SeekToFirst seeks position at the first entry in list.
				Final state of iterator is Valid() iff list is not empty.

			(*Iterator) SeekToLast()
				SeekToLast seeks position at the last entry in list.
				Final state of iterator is Valid() iff list is not empty.

			(*Iterator) Valid() bool
				Valid returns true iff the iterator is positioned at a valid node.

			(*Iterator) Value() y.ValueStruct
				Value returns value.

			(*Iterator) ValueUint64() uint64
				ValueUint64 returns the uint64 value of the current node.

		Implements (at least 2)
			*Iterator : github.com/prometheus/common/expfmt.Closer
			*Iterator : io.Closer
		As Outputs Of (at least one exported)
			func (*Skiplist).NewIterator() *Iterator

	 type Skiplist (struct)

		Fields (only one)
			OnClose func()
		Methods (total 8)
			(*Skiplist) DecrRef()
				DecrRef decrements the refcount, deallocating the Skiplist when done using it

			(*Skiplist) Empty() bool
				Empty returns if the Skiplist is empty.

			(*Skiplist) Get(key []byte) y.ValueStruct
				Get gets the value associated with the key. It returns a valid value if it finds equal or earlier
				version of the same key.

			(*Skiplist) IncrRef()
				IncrRef increases the refcount

			(*Skiplist) MemSize() int64
				MemSize returns the size of the Skiplist in terms of how much memory is used within its internal
				arena.

			(*Skiplist) NewIterator() *Iterator
				NewIterator returns a skiplist iterator.  You have to Close() the iterator.

			(*Skiplist) NewUniIterator(reversed bool) *UniIterator
				NewUniIterator returns a UniIterator.

			(*Skiplist) Put(key []byte, v y.ValueStruct)
				Put inserts the key-value pair.

		As Outputs Of (at least one exported)
			func NewSkiplist(arenaSize int64) *Skiplist

	 type UniIterator (struct)
		UniIterator is a unidirectional memtable iterator. It is a thin wrapper around
		Iterator. We like to keep Iterator as before, because it is more powerful and
		we might support bidirectional iterators in the future.

		Methods (total 7)
			(*UniIterator) Close() error
				Close implements y.Interface (and frees up the iter's resources)

			(*UniIterator) Key() []byte
				Key implements y.Interface

			(*UniIterator) Next()
				Next implements y.Interface

			(*UniIterator) Rewind()
				Rewind implements y.Interface

			(*UniIterator) Seek(key []byte)
				Seek implements y.Interface

			(*UniIterator) Valid() bool
				Valid implements y.Interface

			(*UniIterator) Value() y.ValueStruct
				Value implements y.Interface

		Implements (at least 3)
			*UniIterator : github.com/dgraph-io/badger/v4/y.Iterator
			*UniIterator : github.com/prometheus/common/expfmt.Closer
			*UniIterator : io.Closer
		As Outputs Of (at least one exported)
			func (*Skiplist).NewUniIterator(reversed bool) *UniIterator


Package-Level Functions (only one)

	 func NewSkiplist(arenaSize int64) *Skiplist
		NewSkiplist makes a new empty skiplist, with a given arena size


Package-Level Constants (only one)

	const MaxNodeSize int = 96
		MaxNodeSize is the memory footprint of a node of maximum height.

The pages are generated with Golds v0.8.4. (GOOS=linux GOARCH=amd64)
Golds is a Go 101 project developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @zigo_101 (reachable from the left QR code) to get the latest news of Golds.