index

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

type DocIDPositionIterator interface {
	DocIDSetIterator

	// Position is the position in the backing doc ID set.
	Position() int

	// MaskingPosition is the position in the masking doc ID set.
	MaskingPosition() int
}

type DocIDSet interface {
	// Iter returns the document ID set iterator.
	Iter() DocIDSetIterator

	// Intersect returns the set of positions in the current doc ID set that
	// are also in the doc ID set given by the iterator passed in.
	Intersect(it DocIDSetIterator) DocIDPositionIterator

	// WriteTo writes the document ID set to an io.Writer.
	// NB: extBuf is an external buffer for reuse.
	WriteTo(writer io.Writer, extBuf *bytes.Buffer) error
}

type DocIDSetBuilder interface {
	// Add adds a single document ID.
	Add(docID int32)

	// Snapshot returns an immutable snapshot of the builder state.
	// Snapshot can be processed independently of operations performed against the builder.
	Snapshot() DocIDSet

	// Seal seals a doc ID set effectively making it immutable.
	Seal(numTotalDocs int32) DocIDSet
}

type DocIDSetIterator interface {
	// Next returns true if there are more document IDs to be iterated over.
	Next() bool

	// DocID returns the current document ID.
	// NB: This is not called `Current` because it needs to
	// be embedded with other iterators so the method name is
	// more specific w.r.t. what value this is referring to.
	DocID() int32

	// Err returns any error encountered during iteration.
	Err() error

	// Close closes the iterator.
	Close()
}

type DocIDSetIteratorFn func(it DocIDSetIterator) DocIDSetIterator

type EmptyDocIDSetIterator struct{}

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

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

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

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

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

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

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

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

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

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

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

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

type SeekableDocIDSetIterator interface {
	DocIDSetIterator

	// SeekForward moves the iterator forward n positions.
	SeekForward(n int) error
}