kv

Documentation

Overview

Package kv provides generic key/value pair constructors and helpers

Index

• func New[K any, V any](key K, value V) c.KV[K, V]
• type Collection
• type Convertable
• type Filterable
• type IterFor
• type Iterable
• type Iterator

Functions

func New

func New[K any, V any](key K, value V) c.KV[K, V]

New creates a key/value pair holder

Types

type Collection

type Collection[K comparable, V any, M map[K]V | map[K][]V] interface {
	c.TrackLoop[K, V]
	c.TrackEachLoop[K, V]
	Iterable[K, V]
	c.MapFactory[K, V, M]

	Reduce(merger func(K, K, V, V) (K, V)) (K, V)
}

Collection is the base interface of associative collections

type Convertable

type Convertable[K, V, KVStream, KVStreamBreakable any] interface {
	Convert(converter func(K, V) (K, V)) KVStream
	Conv(converter func(K, V) (K, V, error)) KVStreamBreakable

	ConvertKey(converter func(K) K) KVStream
	ConvertValue(converter func(V) V) KVStream

	ConvKey(converter func(K) (K, error)) KVStreamBreakable
	ConvValue(converter func(V) (V, error)) KVStreamBreakable
}

Convertable provides limited kit of map transformation methods

type Filterable

type Filterable[K, V, KVStream, KVStreamBreakable any] interface {
	Filter(predicate func(K, V) bool) KVStream
	Filt(predicate func(K, V) (bool, error)) KVStreamBreakable

	FilterKey(predicate func(K) bool) KVStream
	FilterValue(predicate func(V) bool) KVStream

	FiltKey(predicate func(K) (bool, error)) KVStreamBreakable
	FiltValue(predicate func(V) (bool, error)) KVStreamBreakable
}

Filterable provides limited kit of filering methods

type IterFor

type IterFor[K, V any, I Iterator[K, V]] interface {
	// Start is used with for loop construct.
	// Returns the iterator itself, the first key/value pair, and ok == false if the iteration must be completed.
	//
	// 	var i IterFor = ...
	// 	for i, k, v, ok := i.Start(); ok; k, v, ok = i.Next() {
	//  	_ = val
	//	}
	Start() (iterator I, key K, value V, ok bool)
}

IterFor extends an iterator type by a 'Start' function implementation

type Iterable

type Iterable[K, V any] interface {
	Iter() Iterator[K, V]
}

Iterable is an iterator supplier interface

type Iterator

type Iterator[K, V any] interface {
	// Next returns the next key/value pair.
	// The ok result indicates whether the element was returned by the iterator.
	// If ok == false, then the iteration must be completed.
	Next() (key K, value V, ok bool)
	c.TrackLoop[K, V]
	c.TrackEachLoop[K, V]
}

Iterator provides iterate over key/value pairs