immutable

package
v0.0.12 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Mar 31, 2024 License: MIT Imports: 15 Imported by: 2

Documentation

Overview

Package immutable provides immutable collection implementations

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Map 

type Map[K comparable, V any] struct {
	// contains filtered or unexported fields
}

Map is a collection implementation that provides elements access by an unique key

func MapFromLoop 

func MapFromLoop[K comparable, V any](next func() (K, V, bool)) Map[K, V]

MapFromLoop creates a map with elements retrieved converter the 'next' function

func NewMap 

func NewMap[K comparable, V any](elements ...c.KV[K, V]) Map[K, V]

NewMap instantiates an map using key/value pairs

func NewMapOf 

func NewMapOf[K comparable, V any](elements map[K]V) Map[K, V]

NewMapOf instantiates Map populated by the 'elements' map key/values

func WrapMap 

func WrapMap[K comparable, V any](elements map[K]V) Map[K, V]

WrapMap instantiates Map using a map as internal storage.

func (Map[K, V]) All added in v0.0.12 

func (m Map[K, V]) All(consumer func(k K, v V) bool)

All is used to iterate through the collection using `for ... range`. Supported since go 1.22 with GOEXPERIMENT=rangefunc enabled.

func (Map[K, V]) Contains 

func (m Map[K, V]) Contains(key K) (ok bool)

Contains checks is the map contains a key

func (Map[K, V]) Conv 

func (m Map[K, V]) Conv(converter func(K, V) (K, V, error)) breakLoop.Loop[K, V]

Conv returns a breakable loop that applies the 'converter' function to the collection elements

func (Map[K, V]) ConvKey 

func (m Map[K, V]) ConvKey(converter func(K) (K, error)) breakLoop.Loop[K, V]

ConvKey returns a loop that applies the 'converter' function to keys of the map

func (Map[K, V]) ConvValue 

func (m Map[K, V]) ConvValue(converter func(V) (V, error)) breakLoop.Loop[K, V]

ConvValue returns a loop that applies the 'converter' function to values of the map

func (Map[K, V]) Convert 

func (m Map[K, V]) Convert(converter func(K, V) (K, V)) loop.Loop[K, V]

Convert returns a loop that applies the 'converter' function to the collection elements

func (Map[K, V]) ConvertKey 

func (m Map[K, V]) ConvertKey(by func(K) K) loop.Loop[K, V]

ConvertKey returns a loop that applies the 'converter' function to keys of the map

func (Map[K, V]) ConvertValue 

func (m Map[K, V]) ConvertValue(by func(V) V) loop.Loop[K, V]

ConvertValue returns a loop that applies the 'converter' function to values of the map

func (Map[K, V]) Filt 

func (m Map[K, V]) Filt(predicate func(K, V) (bool, error)) breakLoop.Loop[K, V]

Filt returns a breakable loop consisting of elements that satisfy the condition of the 'predicate' function

func (Map[K, V]) FiltKey 

func (m Map[K, V]) FiltKey(predicate func(K) (bool, error)) breakLoop.Loop[K, V]

FiltKey returns a loop consisting of key/value pairs where the key satisfies the condition of the 'predicate' function

func (Map[K, V]) FiltValue 

func (m Map[K, V]) FiltValue(predicate func(V) (bool, error)) breakLoop.Loop[K, V]

FiltValue returns a loop consisting of key/value pairs where the value satisfies the condition of the 'predicate' function

func (Map[K, V]) Filter 

func (m Map[K, V]) Filter(predicate func(K, V) bool) loop.Loop[K, V]

Filter returns a loop consisting of elements that satisfy the condition of the 'predicate' function

func (Map[K, V]) FilterKey 

func (m Map[K, V]) FilterKey(predicate func(K) bool) loop.Loop[K, V]

FilterKey returns a loop consisting of key/value pairs where the key satisfies the condition of the 'predicate' function

func (Map[K, V]) FilterValue 

func (m Map[K, V]) FilterValue(predicate func(V) bool) loop.Loop[K, V]

FilterValue returns a loop consisting of key/value pairs where the value satisfies the condition of the 'predicate' function

func (Map[K, V]) First deprecated 

func (m Map[K, V]) First() (map_.Iter[K, V], K, V, bool)

Deprecated: First is deprecated. Will be replaced by rance-over function iterator. First returns the first key/value pair of the map, an iterator to iterate over the remaining pair, and true\false marker of availability next pairs. If no more then ok==false.

func (Map[K, V]) Get 

func (m Map[K, V]) Get(key K) (element V, ok bool)

Get returns the value for a key. If ok==false, then the map does not contain the key.

func (Map[K, V]) HasAny 

func (m Map[K, V]) HasAny(predicate func(K, V) bool) bool

HasAny finds the first key/value pair that satisfies the 'predicate' function condition and returns true if successful

func (Map[K, V]) Head deprecated 

func (m Map[K, V]) Head() map_.Iter[K, V]

Deprecated: Head is deprecated. Will be replaced by rance-over function iterator. Head creates an iterator to iterate through the collection.

func (Map[K, V]) IsEmpty 

func (m Map[K, V]) IsEmpty() bool

IsEmpty returns true if the map is empty

func (Map[K, V]) K 

func (m Map[K, V]) K() MapKeys[K, V]

K resutrns keys collection impl

func (Map[K, V]) Keys 

func (m Map[K, V]) Keys() MapKeys[K, V]

Keys resutrns keys collection

func (Map[K, V]) Len 

func (m Map[K, V]) Len() int

Len returns amount of elements

func (Map[K, V]) Loop 

func (m Map[K, V]) Loop() loop.Loop[K, V]

Loop creates a loop to iterate through the collection.

func (Map[K, V]) Map 

func (m Map[K, V]) Map() map[K]V

Map collects the key/value pairs to a map

func (Map[K, V]) Reduce 

func (m Map[K, V]) Reduce(merge func(K, K, V, V) (K, V)) (K, V)

Reduce reduces the key/value pairs of the map into an one pair using the 'merge' function

func (Map[K, V]) Sort 

func (m Map[K, V]) Sort(comparer slice.Comparer[K]) ordered.Map[K, V]

Sort returns sorted by keys map

func (Map[K, V]) StableSort 

func (m Map[K, V]) StableSort(comparer slice.Comparer[K]) ordered.Map[K, V]

StableSort returns sorted by keys map

func (Map[K, V]) String 

func (m Map[K, V]) String() string

func (Map[K, V]) Track 

func (m Map[K, V]) Track(consumer func(K, V) error) error

Track applies the 'consumer' function for all key/value pairs until the consumer returns the c.Break to stop.

func (Map[K, V]) TrackEach 

func (m Map[K, V]) TrackEach(consumer func(K, V))

TrackEach applies the 'consumer' function for every key/value pairs

func (Map[K, V]) V 

func (m Map[K, V]) V() MapValues[K, V]

V resutrns values collection impl

func (Map[K, V]) Values 

func (m Map[K, V]) Values() MapValues[K, V]

Values resutrns values collection

type MapKeys 

type MapKeys[K comparable, V any] struct {
	// contains filtered or unexported fields
}

MapKeys is the container reveal keys of a map and hides values

func WrapKeys 

func WrapKeys[K comparable, V any](elements map[K]V) MapKeys[K, V]

WrapKeys instantiates MapKeys using the elements as internal storage

func (MapKeys[K, V]) All added in v0.0.12 

func (m MapKeys[K, V]) All(consumer func(K) bool)

All is used to iterate through the collection using `for ... range`. Supported since go 1.22 with GOEXPERIMENT=rangefunc enabled.

func (MapKeys[K, V]) Append 

func (m MapKeys[K, V]) Append(out []K) []K

Append collects the values to the specified 'out' slice

func (MapKeys[K, V]) Conv 

func (m MapKeys[K, V]) Conv(converter func(K) (K, error)) breakLoop.Loop[K]

Conv returns a breakable loop that applies the 'converter' function to the collection elements

func (MapKeys[K, V]) Convert 

func (m MapKeys[K, V]) Convert(converter func(K) K) loop.Loop[K]

Convert returns a loop that applies the 'converter' function to the collection elements

func (MapKeys[K, V]) Filt 

func (m MapKeys[K, V]) Filt(predicate func(K) (bool, error)) breakLoop.Loop[K]

Filt returns a breakable loop consisting of elements that satisfy the condition of the 'predicate' function

func (MapKeys[K, V]) Filter 

func (m MapKeys[K, V]) Filter(filter func(K) bool) loop.Loop[K]

Filter returns a loop consisting of elements that satisfy the condition of the 'predicate' function

func (MapKeys[K, V]) First deprecated 

func (m MapKeys[K, V]) First() (map_.KeyIter[K, V], K, bool)

Deprecated: First is deprecated. Will be replaced by rance-over function iterator. First returns the first element of the collection, an iterator to iterate over the remaining elements, and true\false marker of availability next elements. If no more elements then ok==false.

func (MapKeys[K, V]) For 

func (m MapKeys[K, V]) For(consumer func(K) error) error

For applies the 'consumer' function for every key until the consumer returns the c.Break to stop.

func (MapKeys[K, V]) ForEach 

func (m MapKeys[K, V]) ForEach(consumer func(K))

ForEach applies the 'consumer' function for every key

func (MapKeys[K, V]) HasAny 

func (m MapKeys[K, V]) HasAny(predicate func(K) bool) bool

HasAny finds the first element that satisfies the 'predicate' function condition and returns true if successful

func (MapKeys[K, V]) Head deprecated 

func (m MapKeys[K, V]) Head() map_.KeyIter[K, V]

Deprecated: Head is deprecated. Will be replaced by rance-over function iterator. Head creates an iterator to iterate through the collection.

func (MapKeys[K, V]) IsEmpty 

func (m MapKeys[K, V]) IsEmpty() bool

IsEmpty returns true if the collection is empty

func (MapKeys[K, V]) Len 

func (m MapKeys[K, V]) Len() int

Len returns amount of elements

func (MapKeys[K, V]) Loop 

func (m MapKeys[K, V]) Loop() loop.Loop[K]

Loop creates a loop to iterate through the collection.

func (MapKeys[K, V]) Reduce 

func (m MapKeys[K, V]) Reduce(merge func(K, K) K) K

Reduce reduces the elements into an one using the 'merge' function

func (MapKeys[K, V]) Slice 

func (m MapKeys[K, V]) Slice() []K

Slice collects the elements to a slice

func (MapKeys[K, V]) String 

func (m MapKeys[K, V]) String() string

type MapValues 

type MapValues[K comparable, V any] struct {
	// contains filtered or unexported fields
}

MapValues is the wrapper for Map'm values.

func WrapVal 

func WrapVal[K comparable, V any](elements map[K]V) MapValues[K, V]

WrapVal instantiates MapValues using elements as internal storage.

func (MapValues[K, V]) All added in v0.0.12 

func (m MapValues[K, V]) All(consumer func(V) bool)

All is used to iterate through the collection using `for ... range`. Supported since go 1.22 with GOEXPERIMENT=rangefunc enabled.

func (MapValues[K, V]) Append 

func (m MapValues[K, V]) Append(out []V) []V

Append collects the values to the specified 'out' slice

func (MapValues[K, V]) Conv 

func (m MapValues[K, V]) Conv(converter func(V) (V, error)) breakLoop.Loop[V]

Conv returns a breakable loop that applies the 'converter' function to the collection elements

func (MapValues[K, V]) Convert 

func (m MapValues[K, V]) Convert(converter func(V) V) loop.Loop[V]

Convert returns a loop that applies the 'converter' function to the collection elements

func (MapValues[K, V]) Filt 

func (m MapValues[K, V]) Filt(predicate func(V) (bool, error)) breakLoop.Loop[V]

Filt returns a breakable loop consisting of elements that satisfy the condition of the 'predicate' function

func (MapValues[K, V]) Filter 

func (m MapValues[K, V]) Filter(filter func(V) bool) loop.Loop[V]

Filter returns a loop consisting of elements that satisfy the condition of the 'predicate' function

func (MapValues[K, V]) First deprecated 

func (m MapValues[K, V]) First() (map_.ValIter[K, V], V, bool)

Deprecated: First is deprecated. Will be replaced by rance-over function iterator. First returns the first element of the collection, an iterator to iterate over the remaining elements, and true\false marker of availability next elements. If no more elements then ok==false.

func (MapValues[K, V]) For 

func (m MapValues[K, V]) For(consumer func(V) error) error

For applies the 'consumer' function for collection values until the consumer returns the c.Break to stop.

func (MapValues[K, V]) ForEach 

func (m MapValues[K, V]) ForEach(consumer func(V))

ForEach applies the 'consumer' function for every value of the collection

func (MapValues[K, V]) HasAny 

func (m MapValues[K, V]) HasAny(predicate func(V) bool) bool

HasAny finds the first element that satisfies the 'predicate' function condition and returns true if successful

func (MapValues[K, V]) Head deprecated 

func (m MapValues[K, V]) Head() map_.ValIter[K, V]

Deprecated: Head is deprecated. Will be replaced by rance-over function iterator. Head creates an iterator to iterate through the collection.

func (MapValues[K, V]) IsEmpty 

func (m MapValues[K, V]) IsEmpty() bool

IsEmpty returns true if the collection is empty

func (MapValues[K, V]) Len 

func (m MapValues[K, V]) Len() int

Len returns amount of elements

func (MapValues[K, V]) Loop 

func (m MapValues[K, V]) Loop() loop.Loop[V]

Loop creates a loop to iterate through the collection.

func (MapValues[K, V]) Reduce 

func (m MapValues[K, V]) Reduce(merge func(V, V) V) V

Reduce reduces the elements into an one using the 'merge' function

func (MapValues[K, V]) Slice 

func (m MapValues[K, V]) Slice() []V

Slice collects the values to a slice

func (MapValues[K, V]) Sort 

func (m MapValues[K, V]) Sort(comparer slice.Comparer[V]) Vector[V]

Sort creates a vector with sorted the values

func (MapValues[K, V]) String 

func (m MapValues[K, V]) String() string

type Set 

type Set[T comparable] struct {
	// contains filtered or unexported fields
}

Set is a collection implementation that provides storage for unique elements, prevents duplication. The elements must be comparable.

func NewSet 

func NewSet[T comparable](elements ...T) Set[T]

NewSet instantiates set and copies elements to it

func SetFromLoop 

func SetFromLoop[T comparable](next func() (T, bool)) Set[T]

SetFromLoop creates a set with elements retrieved by the 'next' function. The next returns an element with true or zero value with false if there are no more elements.

func WrapSet 

func WrapSet[T comparable](elements map[T]struct{}) Set[T]

WrapSet creates a set using a map as the internal storage.

func (Set[T]) All added in v0.0.12 

func (s Set[T]) All(consumer func(T) bool)

All is used to iterate through the collection using `for ... range`. Supported since go 1.22 with GOEXPERIMENT=rangefunc enabled.

func (Set[T]) Append 

func (s Set[T]) Append(out []T) []T

Append collects the values to the specified 'out' slice

func (Set[T]) Contains 

func (s Set[T]) Contains(element T) (ok bool)

Contains checks is the collection contains an element

func (Set[T]) Conv 

func (s Set[T]) Conv(converter func(T) (T, error)) breakLoop.Loop[T]

Conv returns a breakable loop that applies the 'converter' function to the collection elements

func (Set[T]) Convert 

func (s Set[T]) Convert(converter func(T) T) loop.Loop[T]

Convert returns a loop that applies the 'converter' function to the collection elements

func (Set[T]) Filt 

func (s Set[T]) Filt(predicate func(T) (bool, error)) breakLoop.Loop[T]

Filt returns a breakable loop consisting of elements that satisfy the condition of the 'predicate' function

func (Set[T]) Filter 

func (s Set[T]) Filter(predicate func(T) bool) loop.Loop[T]

Filter returns a loop consisting of elements that satisfy the condition of the 'predicate' function

func (Set[T]) First deprecated 

func (s Set[T]) First() (map_.KeyIter[T, struct{}], T, bool)

Deprecated: First is deprecated. Will be replaced by rance-over function iterator. First returns the first element of the collection, an iterator to iterate over the remaining elements, and true\false marker of availability next elements. If no more elements then ok==false.

func (Set[T]) For 

func (s Set[T]) For(consumer func(T) error) error

For applies the 'consumer' function for the elements until the consumer returns the c.Break to stop.

func (Set[T]) ForEach 

func (s Set[T]) ForEach(consumer func(T))

ForEach applies the 'consumer' function for every element

func (Set[T]) HasAny 

func (s Set[T]) HasAny(predicate func(T) bool) bool

HasAny finds the first element that satisfies the 'predicate' function condition and returns true if successful

func (Set[T]) Head deprecated 

func (s Set[T]) Head() map_.KeyIter[T, struct{}]

Deprecated: Head is deprecated. Will be replaced by rance-over function iterator. Head creates an iterator to iterate through the collection.

func (Set[T]) IsEmpty 

func (s Set[T]) IsEmpty() bool

IsEmpty returns true if the collection is empty

func (Set[T]) Len 

func (s Set[T]) Len() int

Len returns amount of elements

func (Set[T]) Loop 

func (s Set[T]) Loop() loop.Loop[T]

Loop creates a loop to iterate through the collection.

func (Set[T]) Reduce 

func (s Set[T]) Reduce(merge func(T, T) T) T

Reduce reduces the elements into an one using the 'merge' function

func (Set[T]) Slice 

func (s Set[T]) Slice() []T

Slice collects the elements to a slice

func (Set[T]) Sort 

func (s Set[T]) Sort(comparer slice.Comparer[T]) ordered.Set[T]

Sort transforms to the ordered set with sorted elements

func (Set[T]) StableSort 

func (s Set[T]) StableSort(comparer slice.Comparer[T]) ordered.Set[T]

StableSort transforms to the ordered set with sorted elements

func (Set[T]) String 

func (s Set[T]) String() string

type Vector 

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

Vector is a collection implementation that provides elements order and index access.

func NewVector 

func NewVector[T any](elements ...T) Vector[T]

NewVector instantiates Vector populated by the 'elements' slice

func VectorFromLoop 

func VectorFromLoop[T any](next func() (T, bool)) Vector[T]

VectorFromLoop creates a vector with elements retrieved by the 'next' function. The next returns an element with true or zero value with false if there are no more elements.

func WrapVector 

func WrapVector[T any](elements []T) Vector[T]

WrapVector instantiates Vector using a slise as internal storage.

func (Vector[T]) All added in v0.0.12 

func (v Vector[T]) All(consumer func(int, T) bool)

All is used to iterate through the collection using `for ... range`. Supported since go 1.22 with GOEXPERIMENT=rangefunc enabled.

func (Vector[T]) Append 

func (v Vector[T]) Append(out []T) []T

Append collects the values to the specified 'out' slice

func (Vector[T]) Conv 

func (v Vector[T]) Conv(converter func(T) (T, error)) breakLoop.Loop[T]

Conv returns a breakable loop that applies the 'converter' function to the collection elements

func (Vector[T]) Convert 

func (v Vector[T]) Convert(converter func(T) T) loop.Loop[T]

Convert returns a loop that applies the 'converter' function to the collection elements

func (Vector[T]) Filt 

func (v Vector[T]) Filt(predicate func(T) (bool, error)) breakLoop.Loop[T]

Filt returns a breakable loop consisting of elements that satisfy the condition of the 'predicate' function

func (Vector[T]) Filter 

func (v Vector[T]) Filter(filter func(T) bool) loop.Loop[T]

Filter returns a loop consisting of elements that satisfy the condition of the 'predicate' function

func (Vector[T]) First deprecated 

func (v Vector[T]) First() (*slice.Iter[T], T, bool)

Deprecated: First is deprecated. Will be replaced by rance-over function iterator. First returns the first element of the collection, an iterator to iterate over the remaining elements, and true\false marker of availability next elements. If no more elements then ok==false.

func (Vector[T]) For 

func (v Vector[T]) For(consumer func(T) error) error

For applies the 'consumer' function for the elements until the consumer returns the c.Break to stop.

func (Vector[T]) ForEach 

func (v Vector[T]) ForEach(consumer func(T))

ForEach applies the 'consumer' function for every element

func (Vector[T]) Get 

func (v Vector[T]) Get(index int) (out T, ok bool)

Get returns an element by the index, otherwise, if the provided index is ouf of the vector len, returns zero T and false in the second result

func (Vector[T]) HasAny 

func (v Vector[T]) HasAny(predicate func(T) bool) bool

HasAny finds the first element that satisfies the 'predicate' function condition and returns true if successful

func (Vector[T]) Head deprecated 

func (v Vector[T]) Head() slice.Iter[T]

Deprecated: Head is deprecated. Will be replaced by rance-over function iterator. Head creates an iterator to iterate through the collection.

func (Vector[T]) IsEmpty 

func (v Vector[T]) IsEmpty() bool

IsEmpty returns true if the collection is empty

func (Vector[T]) Last 

func (v Vector[T]) Last() (*slice.Iter[T], T, bool)

Last returns the latest element of the collection, an iterator to reverse iterate over the remaining elements, and true\false marker of availability previous elements. If no more elements then ok==false.

func (Vector[T]) Len 

func (v Vector[T]) Len() int

Len returns amount of elements

func (Vector[T]) Loop 

func (v Vector[T]) Loop() loop.Loop[T]

Loop creates a loop to iterate through the collection.

func (Vector[T]) Reduce 

func (v Vector[T]) Reduce(merge func(T, T) T) T

Reduce reduces the elements into an one using the 'merge' function

func (Vector[T]) Slice 

func (v Vector[T]) Slice() []T

Slice collects the elements to a slice

func (Vector[T]) Sort 

func (v Vector[T]) Sort(comparer slice.Comparer[T]) Vector[T]

Sort returns a sorted clone of the Vector

func (Vector[T]) StableSort 

func (v Vector[T]) StableSort(comparer slice.Comparer[T]) Vector[T]

StableSort returns a stable sorted clone of the Vector

func (Vector[T]) String 

func (v Vector[T]) String() string

func (Vector[T]) Tail deprecated 

func (v Vector[T]) Tail() slice.Iter[T]

Deprecated: Tail is deprecated. Will be replaced by rance-over function iterator. Tail creates an iterator pointing to the end of the collection

func (Vector[T]) Track 

func (v Vector[T]) Track(consumer func(int, T) error) error

Track applies the 'consumer' function for elements until the consumer returns the c.Break to stop.

func (Vector[T]) TrackEach 

func (v Vector[T]) TrackEach(consumer func(int, T))

TrackEach applies the 'consumer' function for every key/value pairs

Source Files

View all Source files

Directories

Path Synopsis
Package map_ provides immutable.Map constructors
 Package map_ provides immutable.Map constructors
Package ordered provides immutable ordered collection implementations
 Package ordered provides immutable ordered collection implementations
map_
Package map_ provides immutale ordered.Map constructors
 Package map_ provides immutale ordered.Map constructors
set
Package set provides ordered.Set constructors and helpers
 Package set provides ordered.Set constructors and helpers
Package set provides unordered immutable.Set constructors and helpers
 Package set provides unordered immutable.Set constructors and helpers
Package vector provides ordered immutable.Vector constructors and helpers
 Package vector provides ordered immutable.Vector constructors and helpers

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.