field

type BaseFieldIterator interface {
	// Next returns true if there are more field values to be iterated over.
	Next() bool

	// DocID returns the current doc ID.
	DocID() int32

	// ValueUnion returns the current value as a value union.
	ValueUnion() field.ValueUnion

	// Err returns the error encountered if any.
	Err() error

	// Close closes the iterator.
	Close()
}

type BoolField interface {
	// DocIDSet returns the doc ID set for which the documents have bool values.
	DocIDSet() index.DocIDSet

	// Values return the collection of bool values. The values collection remains
	// valid until the field is closed.
	Values() values.BoolValues

	// Iter returns the field iterator.
	Iter() (BoolFieldIterator, error)

	// Filter applies the given filter against the field, returning a doc
	// ID set iterator that returns the documents matching the filter.
	Filter(
		op filter.Op,
		filterValue *field.ValueUnion,
		numTotalDocs int32,
	) (index.DocIDSetIterator, error)

	// Fetch fetches the field values from the set of documents given by
	// the doc ID set iterator passed in. If the field doesn't exist in
	// a document from the doc ID set iterator output, it is ignored.
	Fetch(it index.DocIDSetIterator) (MaskingBoolFieldIterator, error)
}

type BoolFieldIterator interface {
	BaseFieldIterator

	// Value returns the current bool value.
	Value() bool
}

type BytesField interface {
	// DocIDSet returns the doc ID set for which the documents have bytes values.
	DocIDSet() index.DocIDSet

	// Values return the collection of bytes values. The values collection remains
	// valid until the field is closed.
	Values() values.BytesValues

	// Iter returns the field iterator.
	Iter() (BytesFieldIterator, error)

	// Filter applies the given filter against the field, returning a doc
	// ID set iterator that returns the documents matching the filter.
	Filter(
		op filter.Op,
		filterValue *field.ValueUnion,
		numTotalDocs int32,
	) (index.DocIDSetIterator, error)

	// Fetch fetches the field values from the set of documents given by
	// the doc ID set iterator passed in. If the field doesn't exist in
	// a document from the doc ID set iterator output, it is ignored.
	Fetch(it index.DocIDSetIterator) (MaskingBytesFieldIterator, error)
}

type BytesFieldIterator interface {
	BaseFieldIterator

	// Value returns the current string value.
	Value() bytes.Bytes
}

type CloseFn func()

type CloseableBoolField interface {
	BoolField

	// ShallowCopy returns a shallow copy of the field sharing access to the
	// underlying resources. As such the resources held will not be released until
	// there are no more references to the field.
	ShallowCopy() CloseableBoolField

	// Close closes the field to release the resources held for the collection.
	Close()
}

type CloseableBytesField interface {
	BytesField

	// ShallowCopy returns a shallow copy of the field sharing access to the
	// underlying resources. As such the resources held will not be released until
	// there are no more references to the field.
	ShallowCopy() CloseableBytesField

	// Close closes the field to release the resources held for the collection.
	Close()
}

type CloseableDoubleField interface {
	DoubleField

	// ShallowCopy returns a shallow copy of the field sharing access to the
	// underlying resources. As such the resources held will not be released until
	// there are no more references to the field.
	ShallowCopy() CloseableDoubleField

	// Close closes the field to release the resources held for the collection.
	Close()
}

type CloseableIntField interface {
	IntField

	// ShallowCopy returns a shallow copy of the field sharing access to the
	// underlying resources. As such the resources held will not be released until
	// there are no more references to the field.
	ShallowCopy() CloseableIntField

	// Close closes the field to release the resources held for the collection.
	Close()
}

type CloseableNullField interface {
	NullField

	// ShallowCopy returns a shallow copy of the field sharing access to the
	// underlying resources. As such the resources held will not be released until
	// there are no more references to the field.
	ShallowCopy() CloseableNullField

	// Close closes the field to release the resources held for the collection.
	Close()
}

type CloseableTimeField interface {
	TimeField

	// ShallowCopy returns a shallow copy of the field sharing access to the
	// underlying resources. As such the resources held will not be released until
	// there are no more references to the field.
	ShallowCopy() CloseableTimeField

	// Close closes the field to release the resources held for the collection.
	Close()
}

type DocsField interface {
	// Metadata returns the field metadata.
	Metadata() DocsFieldMetadata

	// NullField returns the field subset that has null values, or false otherwise.
	// The null field remains valid until the docs field is closed.
	NullField() (NullField, bool)

	// BoolField returns the field subset that has bool values, or false otherwise.
	// The bool field remains valid until the docs field is closed.
	BoolField() (BoolField, bool)

	// IntField returns the field subset that has int values, or false otherwise.
	// The int field remains valid until the docs field is closed.
	IntField() (IntField, bool)

	// DoubleField returns the field subset that has double values, or false otherwise.
	// The double field remains valid until the docs field is closed.
	DoubleField() (DoubleField, bool)

	// BytesField returns the field subset that has bytes values, or false otherwise.
	// The bytes field remains valid until the docs field is closed.
	BytesField() (BytesField, bool)

	// TimeField returns the field subset that has time values, or false otherwise.
	// The time field remains valid until the docs field is closed.
	TimeField() (TimeField, bool)

	// FieldForType returns the typed field for a given type, or false otherwise.
	// The typed field remains valid until the docs field is closed.
	FieldForType(t field.ValueType) (Union, bool)

	// NewDocsFieldFor returns a new docs field containing a shallow copy of the typed
	// fields (sharing access to the underlying resources) specified in the given value
	// type set. If a given type does not exist in the current field, it is added to
	// the value type set returned. If a field type is invalid, an error is returned.
	NewDocsFieldFor(fieldTypes field.ValueTypeSet) (DocsField, field.ValueTypeSet, error)

	// ShallowCopy returns a shallow copy of the docs field sharing access to the
	// underlying resources and typed fields. As such the resources held will not
	// be released until both the shallow copy and the original owner are closed.
	ShallowCopy() DocsField

	// NewMergedDocsField creates a new merged docs field by merging the fields in the current
	// docs field and the other docs field, with the current docs field taking precedence for
	// a given field type if both the current docs field and the other docs field has the corresponding
	// field. Both the current docs field and the other docs field remains valid after the call.
	NewMergedDocsField(other DocsField) DocsField

	// Filter applies the given filter against the different types of fields in the docs field,
	// returning a doc ID set iterator that returns the documents matching the filter.
	Filter(
		op filter.Op,
		filterValue *field.ValueUnion,
		numTotalDocs int32,
	) (index.DocIDSetIterator, error)

	// Close closes the field. It will also releases any resources held iff there is
	// no one holding references to the field.
	Close()
	// contains filtered or unexported methods
}

type DocsFieldBuilder interface {
	// Add adds a value with its document ID.
	Add(docID int32, v field.ValueUnion) error

	// Snapshot return an immutable snapshot of the typed fields for the given
	// value type set, returning the new docs field and any types remaining in
	// the given value type set that's not available in the builder.
	SnapshotFor(fieldTypes field.ValueTypeSet) (DocsField, field.ValueTypeSet, error)

	// Seal seals and closes the builder and returns an immutable docs field that contains (and
	// owns) all the doc IDs and the field values accummulated across `numTotalDocs`
	// documents for this field thus far. The resource ownership is transferred from the
	// builder to the immutable collection as a result. Adding more data to the builder
	// after the builder is sealed will result in an error.
	Seal(numTotalDocs int32) DocsField

	// Close closes the builder.
	Close()
}

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

type DocsFieldMetadata struct {
	FieldPath  []string
	FieldTypes []field.ValueType
}

type DoubleField interface {
	// DocIDSet returns the doc ID set for which the documents have double values.
	DocIDSet() index.DocIDSet

	// Values return the collection of double values. The values collection remains
	// valid until the field is closed.
	Values() values.DoubleValues

	// Iter returns the field iterator.
	Iter() (DoubleFieldIterator, error)

	// Filter applies the given filter against the field, returning a doc
	// ID set iterator that returns the documents matching the filter.
	Filter(
		op filter.Op,
		filterValue *field.ValueUnion,
		numTotalDocs int32,
	) (index.DocIDSetIterator, error)

	// Fetch fetches the field values from the set of documents given by
	// the doc ID set iterator passed in. If the field doesn't exist in
	// a document from the doc ID set iterator output, it is ignored.
	Fetch(it index.DocIDSetIterator) (MaskingDoubleFieldIterator, error)
}

type DoubleFieldIterator interface {
	BaseFieldIterator

	// Value returns the current double value.
	Value() float64
}

type IntField interface {
	// DocIDSet returns the doc ID set for which the documents have int values.
	DocIDSet() index.DocIDSet

	// Values return the collection of int values. The values collection remains
	// valid until the field is closed.
	Values() values.IntValues

	// Iter returns the field iterator.
	Iter() (IntFieldIterator, error)

	// Filter applies the given filter against the field, returning a doc
	// ID set iterator that returns the documents matching the filter.
	Filter(
		op filter.Op,
		filterValue *field.ValueUnion,
		numTotalDocs int32,
	) (index.DocIDSetIterator, error)

	// Fetch fetches the field values from the set of documents given by
	// the doc ID set iterator passed in. If the field doesn't exist in
	// a document from the doc ID set iterator output, it is ignored.
	Fetch(it index.DocIDSetIterator) (MaskingIntFieldIterator, error)
}

type IntFieldIterator interface {
	BaseFieldIterator

	// Value returns the current int value.
	Value() int
}

type MaskingBoolFieldIterator interface {
	BoolFieldIterator
	MaskingFieldIterator
}

type MaskingBytesFieldIterator interface {
	BytesFieldIterator
	MaskingFieldIterator
}

type MaskingDoubleFieldIterator interface {
	DoubleFieldIterator
	MaskingFieldIterator
}

type MaskingFieldIterator interface {
	// MaskingPosition returns the current position in the masking iterator.
	MaskingPosition() int
}

type MaskingIntFieldIterator interface {
	IntFieldIterator
	MaskingFieldIterator
}

type MaskingNullFieldIterator interface {
	NullFieldIterator
	MaskingFieldIterator
}

type MaskingTimeFieldIterator interface {
	TimeFieldIterator
	MaskingFieldIterator
}

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

type NullField interface {
	// DocIDSet returns the doc ID set for which the documents have null values.
	DocIDSet() index.DocIDSet

	// Iter returns the field iterator.
	Iter() NullFieldIterator

	// Filter applies the given filter against the field, returning a doc
	// ID set iterator that returns the documents matching the filter.
	Filter(
		op filter.Op,
		filterValue *field.ValueUnion,
		numTotalDocs int32,
	) (index.DocIDSetIterator, error)

	// Fetch fetches the field doc IDs from the set of documents given by
	// the doc ID set iterator passed in. If the field doesn't exist in
	// a document from the doc ID set iterator output, it is ignored.
	Fetch(it index.DocIDSetIterator) MaskingNullFieldIterator
}

type NullFieldIterator interface {
	BaseFieldIterator
}

type TimeField interface {
	// DocIDSet returns the doc ID set for which the documents have time values.
	DocIDSet() index.DocIDSet

	// Values return the collection of time values. The values collection remains
	// valid until the field is closed.
	Values() values.TimeValues

	// Iter returns the field iterator.
	Iter() (TimeFieldIterator, error)

	// Filter applies the given filter against the field, returning a doc
	// ID set iterator that returns the documents matching the filter.
	Filter(
		op filter.Op,
		filterValue *field.ValueUnion,
		numTotalDocs int32,
	) (index.DocIDSetIterator, error)

	// Fetch fetches the field values from the set of documents given by
	// the doc ID set iterator passed in. If the field doesn't exist in
	// a document from the doc ID set iterator output, it is ignored.
	Fetch(it index.DocIDSetIterator) (MaskingTimeFieldIterator, error)
}

type TimeFieldIterator interface {
	BaseFieldIterator

	// Value returns the current time value.
	Value() int64
}

type Union struct {
	Type        field.ValueType
	NullField   NullField
	BoolField   BoolField
	IntField    IntField
	DoubleField DoubleField
	BytesField  BytesField
	TimeField   TimeField
}