array

type Base interface {
	BaseRef

	// Free will release the memory for this array. After Free is called,
	// the array should no longer be used.
	Free()
}

type BaseBuilder interface {
	// Type returns the type of values that this builder accepts.
	Type() semantic.Type

	// Len returns the currently allocated length for the array builder.
	Len() int

	// Cap returns the current capacity of the underlying array.
	Cap() int

	// Reserve ensures there is enough space for appending n elements by checking
	// the capacity and calling resize if necessary.
	Reserve(n int)

	// AppendNull will append a null value to the array.
	AppendNull()

	// BuildArray will construct the array.
	BuildArray() Base

	// Free will release the memory used for this builder.
	Free()
}

type BaseRef interface {
	// Type returns the type of values that this array contains.
	Type() semantic.Type

	// IsNull will return true if the given index is null.
	IsNull(i int) bool

	// IsValid will return true if the given index is a valid value (not null).
	IsValid(i int) bool

	// Len will return the length of this array.
	Len() int

	// NullN will return the number of null values in this array.
	NullN() int

	// Slice will return a slice of the array.
	Slice(start, stop int) BaseRef

	// Copy will retain a reference to the array.
	Copy() Base
}

type Boolean interface {
	BooleanRef

	// Free will release the memory for this array. After Free is called,
	// the array should no longer be used.
	Free()
}

type BooleanBuilder interface {
	BaseBuilder
	Append(v bool)
	AppendValues(v []bool, valid ...[]bool)

	// BuildBooleanArray will construct the array.
	BuildBooleanArray() Boolean
}

type BooleanRef interface {
	BaseRef
	Value(i int) bool
	BooleanSlice(start, stop int) BooleanRef
}

type Float interface {
	FloatRef

	// Free will release the memory for this array. After Free is called,
	// the array should no longer be used.
	Free()
}

type FloatBuilder interface {
	BaseBuilder
	Append(v float64)
	AppendValues(v []float64, valid ...[]bool)

	// BuildFloatArray will construct the array.
	BuildFloatArray() Float
}

type FloatRef interface {
	BaseRef
	Value(i int) float64
	FloatSlice(start, stop int) FloatRef

	// Float64Values will return the underlying slice for the Float array. It is the size
	// of the array and null values will be present, but the data at null indexes will be invalid.
	Float64Values() []float64
}

type Int interface {
	IntRef

	// Free will release the memory for this array. After Free is called,
	// the array should no longer be used.
	Free()
}

type IntBuilder interface {
	BaseBuilder
	Append(v int64)
	AppendValues(v []int64, valid ...[]bool)

	// BuildIntArray will construct the array.
	BuildIntArray() Int
}

type IntRef interface {
	BaseRef
	Value(i int) int64
	IntSlice(start, stop int) IntRef

	// Int64Values will return the underlying slice for the Int array. It is the size
	// of the array and null values will be present, but the data at null indexes will be invalid.
	Int64Values() []int64
}

type String interface {
	StringRef

	// Free will release the memory for this array. After Free is called,
	// the array should no longer be used.
	Free()
}

type StringBuilder interface {
	BaseBuilder
	Append(v string)
	AppendValues(v []string, valid ...[]bool)

	// BuildStringArray will construct the array.
	BuildStringArray() String
}

type StringRef interface {
	BaseRef
	Value(i int) string
	StringSlice(start, stop int) StringRef
}

type Time interface {
	TimeRef

	// Free will release the memory for this array. After Free is called,
	// the array should no longer be used.
	Free()
}

type TimeBuilder interface {
	BaseBuilder
	Append(v values.Time)
	AppendValues(v []values.Time, valid ...[]bool)

	// BuildTimeArray will construct the array.
	BuildTimeArray() Time
}

type TimeRef interface {
	BaseRef
	Value(i int) values.Time
	TimeSlice(start, stop int) TimeRef
}

type UInt interface {
	UIntRef

	// Free will release the memory for this array. After Free is called,
	// the array should no longer be used.
	Free()
}

type UIntBuilder interface {
	BaseBuilder
	Append(v uint64)
	AppendValues(v []uint64, valid ...[]bool)

	// BuildUIntArray will construct the array.
	BuildUIntArray() UInt
}

type UIntRef interface {
	BaseRef
	Value(i int) uint64
	UIntSlice(start, stop int) UIntRef

	// Uint64Values will return the underlying slice for the UInt array. It is the size
	// of the array and null values will be present, but the data at null indexes will be invalid.
	Uint64Values() []uint64
}

type ValueBuilder struct {
	// Builder holds the BaseBuilder that will be used.
	Builder BaseBuilder
}