block

Documentation

Overview

Package block allows read and write sorted key/value.

Index

• type FilterReader
  • func NewFilterReader(buf []byte, filter filter.Filter) (b *FilterReader, err error)
  • func (b *FilterReader) KeyMayMatch(offset uint, key []byte) bool
• type FilterWriter
  • func NewFilterWriter(filter filter.Filter) *FilterWriter
  • func (b *FilterWriter) Add(key []byte)
  • func (b *FilterWriter) Finish() []byte
  • func (b *FilterWriter) Generate(offset int)
• type Iterator
  • func (i *Iterator) Empty() bool
  • func (i *Iterator) Error() error
  • func (i *Iterator) First() bool
  • func (i *Iterator) Key() []byte
  • func (i *Iterator) Last() bool
  • func (i *Iterator) Next() bool
  • func (i *Iterator) Prev() bool
  • func (i *Iterator) Seek(key []byte) (r bool)
  • func (i *Iterator) Valid() bool
  • func (i *Iterator) Value() []byte
• type Reader
  • func NewReader(buf []byte, cmp comparer.BasicComparer) (b *Reader, err error)
  • func (b *Reader) InitIterator(i *Iterator)
  • func (b *Reader) NewIterator() *Iterator
• type Writer
  • func NewWriter(restartInterval int) *Writer
  • func (b *Writer) Add(key, value []byte)
  • func (b *Writer) CountRestart() int
  • func (b *Writer) Finish() []byte
  • func (b *Writer) Len() int
  • func (b *Writer) Reset()
  • func (b *Writer) Size() int

Types

type FilterReader

type FilterReader struct {
	// contains filtered or unexported fields
}

FilterReader represent a filter block reader.

func NewFilterReader

func NewFilterReader(buf []byte, filter filter.Filter) (b *FilterReader, err error)

NewFilterReader create new initialized filter block reader.

func (*FilterReader) KeyMayMatch

func (b *FilterReader) KeyMayMatch(offset uint, key []byte) bool

KeyMayMatch test whether given key at given offset may match.

type FilterWriter

type FilterWriter struct {
	// contains filtered or unexported fields
}

FilterWriter represent filter block writer.

func NewFilterWriter

func NewFilterWriter(filter filter.Filter) *FilterWriter

NewFilterWriter create new initialized filter block writer.

func (*FilterWriter) Add

func (b *FilterWriter) Add(key []byte)

Add add key to the filter block.

func (*FilterWriter) Finish

func (b *FilterWriter) Finish() []byte

Finish finalize the filter block.

func (*FilterWriter) Generate

func (b *FilterWriter) Generate(offset int)

Generate generate filter up to given offset.

type Iterator

type Iterator struct {
	// contains filtered or unexported fields
}

func (*Iterator) Empty

func (i *Iterator) Empty() bool

func (*Iterator) Error

func (i *Iterator) Error() error

func (*Iterator) First

func (i *Iterator) First() bool

func (*Iterator) Key

func (i *Iterator) Key() []byte

func (*Iterator) Last

func (i *Iterator) Last() bool

func (*Iterator) Next

func (i *Iterator) Next() bool

func (*Iterator) Prev

func (i *Iterator) Prev() bool

func (*Iterator) Seek

func (i *Iterator) Seek(key []byte) (r bool)

func (*Iterator) Valid

func (i *Iterator) Valid() bool

func (*Iterator) Value

func (i *Iterator) Value() []byte

type Reader

type Reader struct {
	// contains filtered or unexported fields
}

Reader represent a block reader.

func NewReader

func NewReader(buf []byte, cmp comparer.BasicComparer) (b *Reader, err error)

NewReader create new initialized block reader.

func (*Reader) InitIterator

func (b *Reader) InitIterator(i *Iterator)

InitIterator initialize given block iterator.

func (*Reader) NewIterator

func (b *Reader) NewIterator() *Iterator

NewIterator create new iterator over the block.

type Writer

type Writer struct {
	// contains filtered or unexported fields
}

Writer represent a block writer,

func NewWriter

func NewWriter(restartInterval int) *Writer

NewWriter create new initialized block writer.

func (*Writer) Add

func (b *Writer) Add(key, value []byte)

Add append key/value to the block.

func (*Writer) CountRestart

func (b *Writer) CountRestart() int

CountRestart return the number of restarts point.

func (*Writer) Finish

func (b *Writer) Finish() []byte

Finish finalize the block. No Add() is possible beyond this unless after Reset(), or panic will raised.

func (*Writer) Len

func (b *Writer) Len() int

Len return the sum of added entries.

func (*Writer) Reset

func (b *Writer) Reset()

Reset reset the states of this block writer.

func (*Writer) Size

func (b *Writer) Size() int

Size return actual size of block in bytes,