concat

Documentation

Index

• Constants
• type Component
  • func NewComponent(path string) Component
  • func (comp Component) Desc() Component
  • func (comp Component) IncludeType() Component
  • func (comp Component) WithSize(size int) Component
• type Indexer
  • func New[T any](extractor schema.PathExtractor[T], encoder codec.Encoder[any], ...) (*Indexer[T], error)
  • func (si *Indexer[T]) Index(v *T, set bool) ([]badgerutils.RawKVPair, error)
  • func (si *Indexer[T]) Lookup(args ...any) (badgerutils.Iterator[expr.Range[[]byte]], error)

Constants

const (
	// DefaultMaxComponentSize is the default size that the binary representation of a component will be padded or truncated to.
	DefaultMaxComponentSize = 256
)

Types

type Component

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

Component represents a component of concatenated keys in index

func NewComponent

func NewComponent(path string) Component

NewComponent creates a new component with the given path.

func (Component) Desc

func (comp Component) Desc() Component

Desc sets the descending flag of the component.

func (Component) IncludeType

func (comp Component) IncludeType() Component

IncludeType sets the includeType flag of the component.

func (Component) WithSize

func (comp Component) WithSize(size int) Component

Size modifies the size of the component.

type Indexer

type Indexer[T any] struct {
	// contains filtered or unexported fields
}

Indexer is an indexer for a struct type that generates keys base on struct fields for a btree index.

func New

func New[T any](
	extractor schema.PathExtractor[T],
	encoder codec.Encoder[any],
	comps ...Component,
) (*Indexer[T], error)

New creates a new indexer for the given struct type and components.

func (*Indexer[T]) Index

func (si *Indexer[T]) Index(v *T, set bool) ([]badgerutils.RawKVPair, error)

Index implements the Indexer interface.

func (*Indexer[T]) Lookup

func (si *Indexer[T]) Lookup(args ...any) (badgerutils.Iterator[expr.Range[[]byte]], error)

Lookup implements the Indexer interface.