kvstreams

type Entry ¶

type Entry struct {
	Key, Value []byte
}

Entry is a single entry in a stream/tree

func Peek(ctx context.Context, it streams.Peekable[Entry]) (*Entry, error)

func (e Entry) Clone() Entry

func (e Entry) String() string

type Iterator ¶

type Iterator = streams.Iterator[Entry]

Iterator iterates over entries

e.g.

if err := it.Seek(ctx, key); err != nil {
  return err
}

var ent Entry

for err := it.Next(ctx, &ent); err != EOS; err = it.Next(ctx, &ent) {
  if err != nil {
	   return err
  }
  // use ent here. ent will be valid until the next call to it.Next
}

type Literal ¶

type Literal = streams.Slice[Entry]

Literal is a stream literal, satisfying the Iterator interface. It can be constructed with a slice using NewLiteral

func NewLiteral(xs []Entry) *Literal

type Span ¶

type Span struct {
	Begin []byte
	End   []byte
}

A span of keys [Begin, End) If you want to include a specific end key, use the KeyAfter function. nil is interpretted as no bound, not as a 0 length key. This behaviour is only releveant for End.

func CloneSpan(x Span) Span

func PrefixSpan(p []byte) Span

func SingleItemSpan(x []byte) Span

func TotalSpan() Span

func (s Span) AllGt(x []byte) bool

func (s Span) AllLt(x []byte) bool

func (s Span) Contains(x []byte) bool

func (s Span) Marshal(out []byte) []byte

func (s *Span) Unmarshal(data []byte) error