collection

package
v1.134.0 Latest Latest
Warning

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

 Go to latest Published: Nov 18, 2025 License: Apache-2.0 Imports: 12 Imported by: 0

Documentation

Overview

* Copyright (C) 2020-2022 Arm Limited or its affiliates and Contributors. All rights reserved. * SPDX-License-Identifier: Apache-2.0

* Copyright (C) 2020-2022 Arm Limited or its affiliates and Contributors. All rights reserved. * SPDX-License-Identifier: Apache-2.0

* Copyright (C) 2020-2022 Arm Limited or its affiliates and Contributors. All rights reserved. * SPDX-License-Identifier: Apache-2.0

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func All 

func All(slice []bool) bool

All returns true if all items of the slice are true.

func AllFunc added in v1.78.0 

func AllFunc[S ~[]E, E any](s S, f func(E) bool) bool

AllFunc returns whether f returns true for all the elements of slice s.

func AllNotEmpty added in v1.49.0 

func AllNotEmpty(strict bool, slice []string) bool

AllNotEmpty returns whether all elements of the slice are not empty. If strict, then whitespaces are considered as empty strings

func AllSequence added in v1.134.0 

func AllSequence(seq iter.Seq[bool]) bool

AllSequence returns true if all items of the sequence are true.

func AllTrue added in v1.78.0 

func AllTrue(values ...bool) bool

AllTrue returns whether all values are true.

func AllTrueSequence added in v1.134.0 

func AllTrueSequence[E any](s iter.Seq[E], f func(E) bool) bool

AllTrueSequence returns whether f returns true for all the elements in a sequence.

func And added in v1.80.0 

func And(values ...bool) bool

And performs an 'and' operation on an array of booleans.

func Any 

func Any(slice []bool) bool

Any returns true if there is at least one element of the slice which is true.

func AnyEmpty added in v1.49.0 

func AnyEmpty(strict bool, slice []string) bool

AnyEmpty returns whether there is one entry in the slice which is empty. If strict, then whitespaces are considered as empty strings

func AnyFalse added in v1.134.0 

func AnyFalse(values ...bool) bool

AnyFalse returns whether there is a value set to false

func AnyFalseSequence added in v1.134.0 

func AnyFalseSequence(eq iter.Seq[bool]) bool

AnyFalseSequence returns true if there is at least one element of the sequence which is false. If the sequence is empty, it also returns true.

func AnyFunc added in v1.78.0 

func AnyFunc[S ~[]E, E any](s S, f func(E) bool) bool

AnyFunc returns whether there is at least one element of slice s for which f() returns true.

func AnySequence added in v1.134.0 

func AnySequence(seq iter.Seq[bool]) bool

AnySequence returns true if there is at least one element of the slice which is true.

func AnyTrue added in v1.78.0 

func AnyTrue(values ...bool) bool

AnyTrue returns whether there is a value set to true

func ConvertListOfPairsToMap added in v1.97.0 

func ConvertListOfPairsToMap(input []string, pairSeparator string) (pairs map[string]string, err error)

func ConvertMapToCommaSeparatedList added in v1.96.0 

func ConvertMapToCommaSeparatedList[K comparable, V any](pairs map[K]V) string

ConvertMapToCommaSeparatedList converts a map to a string of comma separated list of keys and values defined sequentially

func ConvertMapToCommaSeparatedPairsList added in v1.96.0 

func ConvertMapToCommaSeparatedPairsList[K comparable, V any](pairs map[K]V, pairSeparator string) string

ConvertMapToCommaSeparatedPairsList converts a map to a string of comma separated list of key, value pairs.

func ConvertMapToLoggerValues added in v1.116.0 

func ConvertMapToLoggerValues[K comparable, V any](pairs map[K]V) []any

ConvertMapToLoggerValues is similar to ConvertMapToSlice but returns a type compatible with logr.Logger.

func ConvertMapToOrderedCommaSeparatedList added in v1.128.0 

func ConvertMapToOrderedCommaSeparatedList[K cmp.Ordered, V any](pairs map[K]V) string

ConvertMapToOrderedCommaSeparatedList converts a map to a commar-separated list and ensures that the ordering will always be the same

func ConvertMapToOrderedSlice added in v1.128.0 

func ConvertMapToOrderedSlice[K cmp.Ordered, V any](pairs map[K]V) []string

ConvertMapToOrderedSlice converts a map to a slice and ensures that the ordering will always be the same

func ConvertMapToPairSlice added in v1.96.0 

func ConvertMapToPairSlice[K comparable, V any](pairs map[K]V, pairSeparator string) []string

ConvertMapToPairSlice converts a map to list of key value pairs e.g. ["key1=value1", "key2=value2"]

func ConvertMapToSlice added in v1.96.0 

func ConvertMapToSlice[K comparable, V any](pairs map[K]V) []string

ConvertMapToSlice converts a map to list of keys and values listed sequentially e.g. [key1, value1, key2, value2]

func ConvertSliceToCommaSeparatedList added in v1.96.0 

func ConvertSliceToCommaSeparatedList[T any](slice []T) string

ConvertSliceToCommaSeparatedList converts a slice into a string containing a coma separated list

func ConvertSliceToMap added in v1.97.0 

func ConvertSliceToMap[T comparable](input []T) (pairs map[T]T, err error)

ConvertSliceToMap converts a slice of elements into a map e.g. [key1, value1, key2, values2] -> {key1: value1, key2: value2}

func Difference added in v1.134.0 

func Difference[T comparable](slice1, slice2 []T) []T

Difference returns the Difference between slice1 and slice2 (only unique values are returned).

func Each added in v1.134.0 

func Each[T any](s iter.Seq[T], f func(T) error) error

Each iterates over a sequence and executes the passed function against each element. If passed func returns an error, the iteration stops and the error is returned, unless it is EOF.

func Filter added in v1.110.0 

func Filter[S ~[]E, E any](s S, f FilterFunc[E]) S

Filter returns a new slice that contains elements from the input slice which return true when they’re passed as a parameter to the provided filtering function f.

func FilterSequence added in v1.134.0 

func FilterSequence[E any](s iter.Seq[E], f Predicate[E]) (result iter.Seq[E])

FilterSequence returns a new sequence that contains elements from the input sequence which return true when they’re passed as a parameter to the provided filtering function f.

func Find 

func Find(slice *[]string, val string) (int, bool)

Find looks for an element in a slice. If found it will return its index and true; otherwise it will return -1 and false.

func FindInSequence added in v1.134.0 

func FindInSequence[E any](elements iter.Seq[E], predicate Predicate[E]) (int, bool)

FindInSequence searches a collection for an element satisfying the predicate.

func FindInSlice added in v1.49.0 

func FindInSlice(strict bool, slice []string, val ...string) (int, bool)

FindInSlice finds if any values val are present in the slice and if so returns the first index. if strict, it checks for an exact match; otherwise it discards whitespaces and case.

func ForEach added in v1.134.0 

func ForEach[S ~[]E, E any](s S, f func(E))

ForEach iterates over elements and executes the passed function on each element.

func ForEachValues added in v1.134.0 

func ForEachValues[E any](f func(E), values ...E)

ForEachValues iterates over values and executes the passed function on each of them.

func GenericRemove added in v1.4.0 

func GenericRemove(equal func(string, string) bool, slice []string, val ...string) []string

GenericRemove looks for elements in a slice using the equal function. If they're found, it will remove them from the slice.

func Intersection added in v1.134.0 

func Intersection[T comparable](slice1, slice2 []T) []T

Intersection returns the intersection of two slices (only unique values are returned).

func Map added in v1.110.0 

func Map[T1 any, T2 any](s []T1, f MapFunc[T1, T2]) []T2

Map creates a new slice and populates it with the results of calling the provided function on every element in input slice.

func MapSequence added in v1.134.0 

func MapSequence[T1 any, T2 any](s iter.Seq[T1], f MapFunc[T1, T2]) iter.Seq[T2]

MapSequence creates a new sequences and populates it with the results of calling the provided function on every element of the input sequence.

func MapSequenceWithError added in v1.134.0 

func MapSequenceWithError[T1 any, T2 any](s iter.Seq[T1], f MapWithErrorFunc[T1, T2]) iter.Seq[T2]

MapSequenceWithError creates a new sequences and populates it with the results of calling the provided function on every element of the input sequence. If an error happens, the mapping stops.

func MapWithError added in v1.124.0 

func MapWithError[T1 any, T2 any](s []T1, f MapWithErrorFunc[T1, T2]) (result []T2, err error)

MapWithError creates a new slice and populates it with the results of calling the provided function on every element in input slice. If an error happens, the mapping stops and the error returned.

func Match added in v1.127.0 

func Match[E any](e E, matches ...FilterFunc[E]) bool

Match checks whether an element e matches any of the matching functions.

func MatchAll added in v1.127.0 

func MatchAll[E any](e E, matches ...FilterFunc[E]) bool

MatchAll checks whether an element e matches all the matching functions.

func Negate added in v1.80.0 

func Negate(values ...bool) []bool

Negate returns the slice with contrary values.

func OneHot added in v1.80.0 

func OneHot(values ...bool) bool

OneHot returns true if one, and only one, of the supplied values is true. See https://en.wikipedia.org/wiki/One-hot

func Or added in v1.80.0 

func Or(values ...bool) bool

Or performs an 'or' operation on an array of booleans.

func ParseCommaSeparatedList 

func ParseCommaSeparatedList(input string) []string

ParseCommaSeparatedList returns the list of string separated by a comma

func ParseCommaSeparatedListOfPairsToMap added in v1.96.0 

func ParseCommaSeparatedListOfPairsToMap(input, pairSeparator string) (pairs map[string]string, err error)

ParseCommaSeparatedListOfPairsToMap returns a map of key value pairs from a string containing a comma separated list of pairs using pairSeparator to separate between keys and values e.g. key1=value1,key2=value2

func ParseCommaSeparatedListToMap added in v1.71.0 

func ParseCommaSeparatedListToMap(input string) (pairs map[string]string, err error)

ParseCommaSeparatedListToMap returns a map of key value pairs from a string containing a comma separated list

func ParseListWithCleanup added in v1.9.0 

func ParseListWithCleanup(input string, sep string) (newS []string)

ParseListWithCleanup splits a string into a list like strings.Split but also removes any whitespace surrounding the different items for example, ParseListWithCleanup("a, b , c", ",") returns []{"a","b","c"}

func ParseListWithCleanupKeepBlankLines added in v1.12.0 

func ParseListWithCleanupKeepBlankLines(input string, sep string) (newS []string)

ParseListWithCleanupKeepBlankLines splits a string into a list like strings.Split but also removes any whitespace surrounding the different items unless the entire item is whitespace in which case it is converted to an empty string. For example, ParseListWithCleanupKeepBlankLines("a, b , c", ",") returns []{"a","b","c"} ParseListWithCleanupKeepBlankLines("a, b , , c", ",") returns []{"a","b", "", "c"}

func Range added in v1.120.0 

func Range(start, stop int, step *int) []int

Range returns a slice of integers similar to Python's built-in range(). https://docs.python.org/2/library/functions.html#range 

Note: The stop value is always exclusive.

func Reduce added in v1.110.0 

func Reduce[T1, T2 any](s []T1, accumulator T2, f ReduceFunc[T1, T2]) T2

Reduce runs a reducer function f over all elements in the array, in ascending-index order, and accumulates them into a single value.

func ReducesSequence added in v1.134.0 

func ReducesSequence[T1, T2 any](s iter.Seq[T1], accumulator T2, f ReduceFunc[T1, T2]) (result T2)

ReducesSequence runs a reducer function f over all elements of a sequence, in ascending-index order, and accumulates them into a single value.

func Reject added in v1.110.0 

func Reject[S ~[]E, E any](s S, f FilterFunc[E]) S

Reject is the opposite of Filter and returns the elements of collection for which the filtering function f returns false. This is functionally equivalent to slices.DeleteFunc but it returns a new slice.

func RejectSequence added in v1.134.0 

func RejectSequence[E any](s iter.Seq[E], f FilterFunc[E]) iter.Seq[E]

RejectSequence is the opposite of FilterSequence and returns the elements of collection for which the filtering function f returns false.

func Remove added in v1.4.0 

func Remove(slice []string, val ...string) []string

Remove looks for elements in a slice. If they're found, it will remove them.

func SymmetricDifference added in v1.134.0 

func SymmetricDifference[T comparable](slice1, slice2 []T) []T

SymmetricDifference returns the symmetric difference between slice1 and slice2 (only unique values are returned).

func Union added in v1.134.0 

func Union[T comparable](slice1, slice2 []T) []T

Union returns the union of two slices (only unique values are returned).

func Unique added in v1.134.0 

func Unique[T comparable](s iter.Seq[T]) []T

Unique returns all the unique values contained in a sequence.

func UniqueEntries added in v1.75.0 

func UniqueEntries[T comparable](slice []T) []T

UniqueEntries returns all the unique values contained in a slice.

func Xor added in v1.80.0 

func Xor(values ...bool) bool

Xor performs a `xor` on an array of booleans. This behaves like an XOR gate; it returns true if the number of true values is odd, and false if the number of true values is zero or even.

Types

type Conditions added in v1.80.0 

type Conditions []bool

func NewConditions added in v1.80.0 

func NewConditions(capacity int) Conditions

NewConditions creates a set of conditions.

func NewConditionsFromValues added in v1.80.0 

func NewConditionsFromValues(conditions ...bool) Conditions

NewConditionsFromValues creates a set of conditions.

func (*Conditions) Add added in v1.80.0 

func (c *Conditions) Add(conditions ...bool) Conditions

Add adds conditions and returns itself.

func (*Conditions) All added in v1.80.0 

func (c *Conditions) All() bool

All returns true if all conditions are true.

func (*Conditions) And added in v1.80.0 

func (c *Conditions) And() bool

And performs an `and` operation on all conditions

func (*Conditions) Any added in v1.80.0 

func (c *Conditions) Any() bool

Any returns true if there is at least one condition which is true.

func (*Conditions) Concat added in v1.80.0 

func (c *Conditions) Concat(more *Conditions) Conditions

Concat concatenates conditions and returns itself.

func (*Conditions) Contains added in v1.80.0 

func (c *Conditions) Contains(condition bool) bool

Contains returns whether the conditions collection contains the value of a condition.

func (*Conditions) ForEach added in v1.80.0 

func (c *Conditions) ForEach(each func(bool) error) error

ForEach will execute function each() on every condition unless an error is returned and will end add this point.

func (*Conditions) Negate added in v1.80.0 

func (c *Conditions) Negate() Conditions

Negate returns a new set of conditions with negated values.

func (*Conditions) OneHot added in v1.80.0 

func (c *Conditions) OneHot() bool

OneHot performs an `OneHot` operation on all conditions

func (*Conditions) Or added in v1.80.0 

func (c *Conditions) Or() bool

Or performs an `Or` operation on all conditions

func (*Conditions) Xor added in v1.80.0 

func (c *Conditions) Xor() bool

Xor performs a `Xor` operation on all conditions

type FilterFunc added in v1.120.0 

type FilterFunc[E any] func(E) bool

func OppositeFunc added in v1.134.0 

func OppositeFunc[E any](f FilterFunc[E]) FilterFunc[E]

OppositeFunc returns the opposite of a FilterFunc.

type MapFunc added in v1.120.0 

type MapFunc[T1, T2 any] func(T1) T2

func IdentityMapFunc added in v1.120.0 

func IdentityMapFunc[T any]() MapFunc[T, T]

type MapWithErrorFunc added in v1.124.0 

type MapWithErrorFunc[T1, T2 any] func(T1) (T2, error)

type Predicate added in v1.134.0 

type Predicate[E any] = FilterFunc[E]

type ReduceFunc added in v1.120.0 

type ReduceFunc[T1, T2 any] func(T2, T1) T2

Source Files

View all Source files

Directories

Path Synopsis
Package pagination provides a ways to iterate over collections.
 Package pagination provides a ways to iterate over collections.

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.