posting

Documentation

Overview

Package posting implements a posting list contains a list of document ids.

Index

• Variables
• type Iterator
• type List

Variables

var ErrListEmpty = errors.New("postings list is empty")

ErrListEmpty indicates the postings list is empty.

Types

type Iterator

type Iterator interface {
	Next() bool

	Current() uint64

	Close() error
}

Iterator allows iterating over a posting list.

type List

type List interface {
	Contains(id uint64) bool

	IsEmpty() bool

	Max() (uint64, error)

	Len() int

	Iterator() Iterator

	Clone() List

	Equal(other List) bool

	Insert(i uint64)

	Intersect(other List) error

	Difference(other List) error

	Union(other List) error

	UnionMany(others []List) error

	AddIterator(iter Iterator) error

	AddRange(min, max uint64) error

	RemoveRange(min, max uint64) error

	Reset()

	ToSlice() []uint64

	Marshall() ([]byte, error)

	Unmarshall(data []byte) error

	SizeInBytes() int64
}

List is a collection of uint64.