collections

Documentation

Index

• Constants
• func IsValidSortDirection(direction SortDirection) bool
• func ToSlice(ctx context.Context, scope *core.Scope, iterator Iterator) ([]*core.Scope, error)
• type Collection
• type CollectionIterator
• type Comparator
• type FilterIterator
  • func NewFilterIterator(values Iterator, predicate FilterPredicate) (*FilterIterator, error)
  • func (iterator *FilterIterator) Next(ctx context.Context, scope *core.Scope) (*core.Scope, error)
• type FilterPredicate
• type HTMLNodeIterator
  • func (iterator *HTMLNodeIterator) Next(_ context.Context, scope *core.Scope) (*core.Scope, error)
• type IndexedCollection
• type IndexedIterator
  • func (iterator *IndexedIterator) Next(_ context.Context, scope *core.Scope) (*core.Scope, error)
• type Iterable
• type IterableCollection
• type Iterator
  • func NewCollectionIterator(valVar, keyVar string, values CollectionIterator) (Iterator, error)
  • func NewDefaultIndexedIterator(values IndexedCollection) (Iterator, error)
  • func NewDefaultKeyedIterator(input KeyedCollection) (Iterator, error)
  • func NewDefaultMapIterator(values map[string]core.Value) (Iterator, error)
  • func NewDefaultSliceIterator(input []core.Value) (Iterator, error)
  • func NewHTMLNodeIterator(valVar, keyVar string, values values.HTMLNode) (Iterator, error)
  • func NewIndexedIterator(valVar, keyVar string, values IndexedCollection) (Iterator, error)
  • func NewKeyedIterator(valVar, keyVar string, values KeyedCollection) (Iterator, error)
  • func NewMapIterator(valVar, keyVar string, values map[string]core.Value) (Iterator, error)
  • func NewSliceIterator(valVar, keyVar string, values []core.Value) (Iterator, error)
  • func NewTapIterator(values Iterator, predicate core.Expression) (Iterator, error)
• type KeyedCollection
• type KeyedIterator
  • func (iterator *KeyedIterator) Next(_ context.Context, scope *core.Scope) (*core.Scope, error)
• type LimitIterator
  • func NewLimitIterator(values Iterator, count, offset int) (*LimitIterator, error)
  • func (iterator *LimitIterator) Next(ctx context.Context, scope *core.Scope) (*core.Scope, error)
• type MapIterator
  • func (iterator *MapIterator) Next(_ context.Context, scope *core.Scope) (*core.Scope, error)
• type SliceIterator
  • func (iterator *SliceIterator) Next(_ context.Context, scope *core.Scope) (*core.Scope, error)
• type SortDirection
  • func SortDirectionFromString(str string) SortDirection
• type SortIterator
  • func NewSortIterator(values Iterator, comparators ...*Sorter) (*SortIterator, error)
  • func (iterator *SortIterator) Next(ctx context.Context, scope *core.Scope) (*core.Scope, error)
• type Sorter
  • func NewSorter(fn Comparator, direction SortDirection) (*Sorter, error)
• type TapIterator
  • func (iterator *TapIterator) Next(ctx context.Context, scope *core.Scope) (*core.Scope, error)
• type UniqueIterator
  • func NewUniqueIterator(values Iterator, hashKey string) (*UniqueIterator, error)
  • func (iterator *UniqueIterator) Next(ctx context.Context, scope *core.Scope) (*core.Scope, error)

Constants

const (
	DefaultValueVar = "value"
	DefaultKeyVar   = "key"
)

Functions

func IsValidSortDirection

func IsValidSortDirection(direction SortDirection) bool

func ToSlice

func ToSlice(ctx context.Context, scope *core.Scope, iterator Iterator) ([]*core.Scope, error)

Types

type Collection

type Collection interface {
	core.Value
	Length() values.Int
}

type CollectionIterator

type CollectionIterator interface {
	Next(ctx context.Context) (value core.Value, key core.Value, err error)
}

type Comparator

type Comparator func(ctx context.Context, first, second *core.Scope) (int, error)

type FilterIterator

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

func NewFilterIterator

func NewFilterIterator(values Iterator, predicate FilterPredicate) (*FilterIterator, error)

func (*FilterIterator) Next

func (iterator *FilterIterator) Next(ctx context.Context, scope *core.Scope) (*core.Scope, error)

type FilterPredicate

type FilterPredicate func(ctx context.Context, scope *core.Scope) (bool, error)

type HTMLNodeIterator

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

func (*HTMLNodeIterator) Next

func (iterator *HTMLNodeIterator) Next(_ context.Context, scope *core.Scope) (*core.Scope, error)

type IndexedCollection

type IndexedCollection interface {
	Collection
	Get(idx values.Int) core.Value
	Set(idx values.Int, value core.Value) error
}

type IndexedIterator

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

func (*IndexedIterator) Next

func (iterator *IndexedIterator) Next(_ context.Context, scope *core.Scope) (*core.Scope, error)

type Iterable

type Iterable interface {
	Iterate(ctx context.Context, scope *core.Scope) (Iterator, error)
}

type IterableCollection

type IterableCollection interface {
	core.Value
	Iterate(ctx context.Context) (CollectionIterator, error)
}

type Iterator

type Iterator interface {
	Next(ctx context.Context, scope *core.Scope) (*core.Scope, error)
}

func NewCollectionIterator

func NewCollectionIterator(
	valVar,
	keyVar string,
	values CollectionIterator,
) (Iterator, error)

func NewDefaultIndexedIterator

func NewDefaultIndexedIterator(
	values IndexedCollection,
) (Iterator, error)

func NewDefaultKeyedIterator

func NewDefaultKeyedIterator(input KeyedCollection) (Iterator, error)

func NewDefaultMapIterator

func NewDefaultMapIterator(values map[string]core.Value) (Iterator, error)

func NewDefaultSliceIterator

func NewDefaultSliceIterator(input []core.Value) (Iterator, error)

func NewHTMLNodeIterator

func NewHTMLNodeIterator(
	valVar,
	keyVar string,
	values values.HTMLNode,
) (Iterator, error)

func NewIndexedIterator

func NewIndexedIterator(
	valVar,
	keyVar string,
	values IndexedCollection,
) (Iterator, error)

func NewKeyedIterator

func NewKeyedIterator(
	valVar,
	keyVar string,
	values KeyedCollection,
) (Iterator, error)

func NewMapIterator

func NewMapIterator(
	valVar,
	keyVar string,
	values map[string]core.Value,
) (Iterator, error)

func NewSliceIterator

func NewSliceIterator(
	valVar,
	keyVar string,
	values []core.Value,
) (Iterator, error)

func NewTapIterator

func NewTapIterator(values Iterator, predicate core.Expression) (Iterator, error)

type KeyedCollection

type KeyedCollection interface {
	Collection
	Keys() []string
	Get(key values.String) (core.Value, values.Boolean)
	Set(key values.String, value core.Value)
}

type KeyedIterator

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

func (*KeyedIterator) Next

func (iterator *KeyedIterator) Next(_ context.Context, scope *core.Scope) (*core.Scope, error)

type LimitIterator

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

func NewLimitIterator

func NewLimitIterator(values Iterator, count, offset int) (*LimitIterator, error)

func (*LimitIterator) Next

func (iterator *LimitIterator) Next(ctx context.Context, scope *core.Scope) (*core.Scope, error)

type MapIterator

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

func (*MapIterator) Next

func (iterator *MapIterator) Next(_ context.Context, scope *core.Scope) (*core.Scope, error)

type SliceIterator

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

func (*SliceIterator) Next

func (iterator *SliceIterator) Next(_ context.Context, scope *core.Scope) (*core.Scope, error)

type SortDirection

type SortDirection int

const (
	SortDirectionAsc  SortDirection = 1
	SortDirectionDesc SortDirection = -1
)

func SortDirectionFromString

func SortDirectionFromString(str string) SortDirection

type SortIterator

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

func NewSortIterator

func NewSortIterator(
	values Iterator,
	comparators ...*Sorter,
) (*SortIterator, error)

func (*SortIterator) Next

func (iterator *SortIterator) Next(ctx context.Context, scope *core.Scope) (*core.Scope, error)

type Sorter

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

func NewSorter

func NewSorter(fn Comparator, direction SortDirection) (*Sorter, error)

type TapIterator

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

func (*TapIterator) Next

func (iterator *TapIterator) Next(ctx context.Context, scope *core.Scope) (*core.Scope, error)

type UniqueIterator

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

func NewUniqueIterator

func NewUniqueIterator(values Iterator, hashKey string) (*UniqueIterator, error)

func (*UniqueIterator) Next

func (iterator *UniqueIterator) Next(ctx context.Context, scope *core.Scope) (*core.Scope, error)