document

type Coder interface {
	Decoder
	Encoder
}

type Collection interface {
	Schema
}

type Decoder interface {
	// DecodeDocument returns the decorded object from the specified reader if available, otherwise returns an error.
	DecodeDocument(r io.Reader) (Object, error)
}

type Element interface {
	// Name returns the unique name.
	Name() string
	// Type returns the index type.
	Type() ElementType
	// Data returns the raw representation data in memory.
	Data() any
	// SetName sets the specified name to the element.
	SetName(name string) Element
	// SetType sets the specified type to the element.
	SetType(t ElementType) Element
}

type ElementType int8

type Elements []Element

type Encoder interface {
	// EncodeDocument writes the specified object to the specified writer.
	EncodeDocument(w io.Writer, obj Object) error
}

type Index interface {
	// Name returns the unique name.
	Name() string
	// Type returns the index type.
	Type() IndexType
	// Elements returns the schema elements.
	Elements() []Element
	// SetName sets the specified name to the index.
	SetName(name string) Index
	// SetType sets the specified type to the element.
	SetType(t IndexType) Index
	// AddElement returns the schema elements.
	AddElement(elem Element) Index
	// Data returns the raw representation data in memory.
	Data() any
}

type IndexType = uint8

type Indexes []Index

type Key []any

type KeyCoder interface {
	KeyDecoder
	KeyEncoder
}

type KeyDecoder interface {
	// DecodeKey returns the decoded key from the specified bytes if available, otherwise returns an error.
	DecodeKey([]byte) (Key, error)
}

type KeyEncoder interface {
	// EncodeKey returns the encoded bytes from the specified key if available, otherwise returns an error.
	EncodeKey(Key) ([]byte, error)
}

type MapObject map[string]any

type Object = any

type Schema interface {
	// Version returns the schema version.
	Version() int
	// SetName sets the specified name to the schema.
	SetName(name string)
	// Name returns the schema name.
	Name() string
	// AddElement adds the specified element to the schema.
	AddElement(elem Element)
	// Elements returns the schema elements.
	Elements() Elements
	// FindElement returns the schema elements by the specified name.
	FindElement(name string) (Element, error)
	// AddIndex adds the specified index to the schema.
	AddIndex(idx Index)
	// Indexes returns the schema indexes.
	Indexes() Indexes
	// FindIndex returns the schema index by the spacified name.
	FindIndex(name string) (Index, error)
	// PrimaryIndex returns the schema primary index.
	PrimaryIndex() (Index, error)
	// SecondaryIndexes returns the schema secondary indexes.
	SecondaryIndexes() (Indexes, error)
	// Data returns the raw representation data in memory.
	Data() any
}