bucketteer

package

v0.3.0 Latest Latest Go to latest Published: Feb 26, 2024 License: AGPL-3.0 Imports: 13 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

View Source

const Version = uint64(2)

View Source

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

func Hash(sig [64]byte) uint64

func Magic() [8]byte

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

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

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

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

func (r *Reader) Close() error

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

func (r *Reader) Meta() *indexmeta.Meta

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

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

func (b *Writer) Close() error

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

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

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

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

func (b *Writer) Seal(meta indexmeta.Meta) (int64, error)

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

Path	Synopsis
example