bucketteer

Documentation

Index

• Constants
• Variables
• func Hash(sig [64]byte) uint64
• func Magic() [8]byte
• type Reader
  • func NewReader(reader io.ReaderAt) (*Reader, error)
  • func Open(path string) (*Reader, error)
  • func (r *Reader) Close() error
  • func (r *Reader) GetMeta(key string) string
  • func (r *Reader) Has(sig [64]byte) (bool, error)
  • func (r *Reader) Meta() map[string]string
• type Writer
  • func NewWriter(path string) (*Writer, error)
  • func (b *Writer) Close() error
  • func (b *Writer) Has(sig [64]byte) bool
  • func (b *Writer) Put(sig [64]byte)
  • func (b *Writer) Seal(meta map[string]string) (int64, error)

Constants

const Version = uint64(1)

Variables

var ErrNotFound = fmt.Errorf("not found")

Functions

func Hash

func Hash(sig [64]byte) uint64

func Magic

func Magic() [8]byte

Types

type Reader

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

func NewReader

func NewReader(reader io.ReaderAt) (*Reader, error)

func Open

func Open(path string) (*Reader, error)

Open opens a Bucketteer file in read-only mode, using memory-mapped IO.

func (*Reader) Close

func (r *Reader) Close() error

func (*Reader) GetMeta

func (r *Reader) GetMeta(key string) string

GetMeta returns the value of the given key. Returns an empty string if the key does not exist.

func (*Reader) Has

func (r *Reader) Has(sig [64]byte) (bool, error)

func (*Reader) Meta

func (r *Reader) Meta() map[string]string

type Writer

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

func NewWriter

func NewWriter(path string) (*Writer, error)

func (*Writer) Close

func (b *Writer) Close() error

func (*Writer) Has

func (b *Writer) Has(sig [64]byte) bool

Has returns true if the Bucketteer has seen the given signature.

func (*Writer) Put

func (b *Writer) Put(sig [64]byte)

Put adds the given signature to the Bucketteer. Cannot be called concurrently.

func (*Writer) Seal

func (b *Writer) Seal(meta map[string]string) (int64, error)

Seal writes the Bucketteer's state to the given writer.