113 lines
4.7 KiB
Go
113 lines
4.7 KiB
Go
package indexes
|
|
|
|
import (
|
|
"context"
|
|
|
|
"cosmossdk.io/collections"
|
|
"cosmossdk.io/collections/codec"
|
|
)
|
|
|
|
// Unique identifies an index that imposes uniqueness constraints on the reference key.
|
|
// It creates relationships between reference and primary key of the value.
|
|
type Unique[ReferenceKey, PrimaryKey, Value any] collections.GenericUniqueIndex[ReferenceKey, PrimaryKey, PrimaryKey, Value]
|
|
|
|
// NewUnique instantiates a new Unique index.
|
|
func NewUnique[ReferenceKey, PrimaryKey, Value any](
|
|
schema *collections.SchemaBuilder,
|
|
prefix collections.Prefix,
|
|
name string,
|
|
refCodec codec.KeyCodec[ReferenceKey],
|
|
pkCodec codec.KeyCodec[PrimaryKey],
|
|
getRefKeyFunc func(pk PrimaryKey, v Value) (ReferenceKey, error),
|
|
) *Unique[ReferenceKey, PrimaryKey, Value] {
|
|
i := collections.NewGenericUniqueIndex(schema, prefix, name, refCodec, pkCodec, func(pk PrimaryKey, value Value) ([]collections.IndexReference[ReferenceKey, PrimaryKey], error) {
|
|
ref, err := getRefKeyFunc(pk, value)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
return []collections.IndexReference[ReferenceKey, PrimaryKey]{
|
|
collections.NewIndexReference(ref, pk),
|
|
}, nil
|
|
})
|
|
|
|
return (*Unique[ReferenceKey, PrimaryKey, Value])(i)
|
|
}
|
|
|
|
func (i *Unique[ReferenceKey, PrimaryKey, Value]) Reference(ctx context.Context, pk PrimaryKey, newValue Value, oldValue *Value) error {
|
|
return (*collections.GenericUniqueIndex[ReferenceKey, PrimaryKey, PrimaryKey, Value])(i).Reference(ctx, pk, newValue, oldValue)
|
|
}
|
|
|
|
func (i *Unique[ReferenceKey, PrimaryKey, Value]) Unreference(ctx context.Context, pk PrimaryKey, value Value) error {
|
|
return (*collections.GenericUniqueIndex[ReferenceKey, PrimaryKey, PrimaryKey, Value])(i).Unreference(ctx, pk, value)
|
|
}
|
|
|
|
func (i *Unique[ReferenceKey, PrimaryKey, Value]) MatchExact(ctx context.Context, ref ReferenceKey) (PrimaryKey, error) {
|
|
return (*collections.GenericUniqueIndex[ReferenceKey, PrimaryKey, PrimaryKey, Value])(i).Get(ctx, ref)
|
|
}
|
|
|
|
func (i *Unique[ReferenceKey, PrimaryKey, Value]) Iterate(ctx context.Context, ranger collections.Ranger[ReferenceKey]) (UniqueIterator[ReferenceKey, PrimaryKey], error) {
|
|
iter, err := (*collections.GenericUniqueIndex[ReferenceKey, PrimaryKey, PrimaryKey, Value])(i).Iterate(ctx, ranger)
|
|
return (UniqueIterator[ReferenceKey, PrimaryKey])(iter), err
|
|
}
|
|
|
|
func (i *Unique[ReferenceKey, PrimaryKey, Value]) Walk(
|
|
ctx context.Context,
|
|
ranger collections.Ranger[ReferenceKey],
|
|
walkFunc func(indexingKey ReferenceKey, indexedKey PrimaryKey) bool,
|
|
) error {
|
|
return (*collections.GenericUniqueIndex[ReferenceKey, PrimaryKey, PrimaryKey, Value])(i).Walk(ctx, ranger, walkFunc)
|
|
}
|
|
|
|
func (i *Unique[ReferenceKey, PrimaryKey, Value]) IterateRaw(ctx context.Context, start, end []byte, order collections.Order) (u UniqueIterator[ReferenceKey, PrimaryKey], err error) {
|
|
iter, err := (*collections.GenericUniqueIndex[ReferenceKey, PrimaryKey, PrimaryKey, Value])(i).IterateRaw(ctx, start, end, order)
|
|
if err != nil {
|
|
return
|
|
}
|
|
return (UniqueIterator[ReferenceKey, PrimaryKey])(iter), nil
|
|
}
|
|
|
|
// UniqueIterator is an Iterator wrapper, that exposes only the functionality needed to work with Unique keys.
|
|
type UniqueIterator[ReferenceKey, PrimaryKey any] collections.Iterator[ReferenceKey, PrimaryKey]
|
|
|
|
// PrimaryKey returns the iterator's current primary key.
|
|
func (i UniqueIterator[ReferenceKey, PrimaryKey]) PrimaryKey() (PrimaryKey, error) {
|
|
return (collections.Iterator[ReferenceKey, PrimaryKey])(i).Value()
|
|
}
|
|
|
|
// PrimaryKeys fully consumes the iterator, and returns all the primary keys.
|
|
func (i UniqueIterator[ReferenceKey, PrimaryKey]) PrimaryKeys() ([]PrimaryKey, error) {
|
|
return (collections.Iterator[ReferenceKey, PrimaryKey])(i).Values()
|
|
}
|
|
|
|
// FullKey returns the iterator's current full reference key as Pair[ReferenceKey, PrimaryKey].
|
|
func (i UniqueIterator[ReferenceKey, PrimaryKey]) FullKey() (collections.Pair[ReferenceKey, PrimaryKey], error) {
|
|
kv, err := (collections.Iterator[ReferenceKey, PrimaryKey])(i).KeyValue()
|
|
return collections.Join(kv.Key, kv.Value), err
|
|
}
|
|
|
|
func (i UniqueIterator[ReferenceKey, PrimaryKey]) FullKeys() ([]collections.Pair[ReferenceKey, PrimaryKey], error) {
|
|
kvs, err := (collections.Iterator[ReferenceKey, PrimaryKey])(i).KeyValues()
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
pairKeys := make([]collections.Pair[ReferenceKey, PrimaryKey], len(kvs))
|
|
for index := range kvs {
|
|
kv := kvs[index]
|
|
pairKeys[index] = collections.Join(kv.Key, kv.Value)
|
|
}
|
|
return pairKeys, nil
|
|
}
|
|
|
|
func (i UniqueIterator[ReferenceKey, PrimaryKey]) Next() {
|
|
(collections.Iterator[ReferenceKey, PrimaryKey])(i).Next()
|
|
}
|
|
|
|
func (i UniqueIterator[ReferenceKey, PrimaryKey]) Valid() bool {
|
|
return (collections.Iterator[ReferenceKey, PrimaryKey])(i).Valid()
|
|
}
|
|
|
|
func (i UniqueIterator[ReferenceKey, PrimaryKey]) Close() error {
|
|
return (collections.Iterator[ReferenceKey, PrimaryKey])(i).Close()
|
|
}
|