collections

Documentation

Overview

Package priorityqueue implements a priority queue backed by binary queue.

A thread-safe priority queue based on a priority queue. The elements of the priority queue are ordered by a comparator provided at queue construction time.

The heap of this queue is the least/smallest element with respect to the specified ordering. If multiple elements are tied for least value, the heap is one of those elements arbitrarily.

Structure is thread safe.

References: https://en.wikipedia.org/wiki/Priority_queue

Index

• func Append[T any](slices ...[]T) []T
• func Contains[T comparable](a []T, x T) bool
• func Dedup[T comparable](arr []T) []T
• func DeleteEmptyStrings(s []string) []string
• func Find(a []string, x string) int
• func IniToMap(path string) map[string]string
• func KeyValueSliceToMap(in []string) map[string]string
• func MapKeys[K comparable, T any](m map[K]T) []K
• func MapToIni(Map map[string]string) string
• func MatchItems(item string, items ...string) bool
• func MergeMap[T1 comparable, T2 any](a, b map[T1]T2) map[T1]T2
• func MergeStructs[T any](base, patch T) (T, error)
• func ReplaceAllInSlice(a []string, find string, replacement string) (replaced []string)
• func SelectorToMap(selector string) (matchLabels map[string]string)
• func SortedMap(m map[string]string) string
• func SplitAllInSlice(a []string, split string, index int) (replaced []string)
• func StructToIni(s interface{}) string
• func StructToJSON(v any) (string, error)
• func StructToMap(s interface{}) map[string]interface{}
• func ToBase64Map(m map[string]interface{}) map[string]string
• func ToByteMap(m map[string]interface{}) map[string][]byte
• func ToGenericMap(m map[string]string) map[string]interface{}
• func ToString(i interface{}) string
• func ToStringMap(m map[string]interface{}) map[string]string
• type Equals
• type MetricsOpts
• type Queue
  • func NewQueue[T comparable](opts QueueOpts[T]) (*Queue[T], error)
  • func (queue *Queue[T]) Clear()
  • func (queue *Queue[T]) Dequeue() (T, bool)
  • func (queue *Queue[T]) Empty() bool
  • func (queue *Queue[T]) Enqueue(value T)
  • func (queue *Queue[T]) EnqueueWithDelay(value T, delay time.Duration)
  • func (queue *Queue[T]) Iterator() iter.Seq[T]
  • func (queue *Queue[T]) Peek() (value T, ok bool)
  • func (queue *Queue[T]) Size() int
  • func (queue *Queue[T]) String() string
  • func (queue *Queue[T]) Values() []T
• type QueueOpts

Functions

func Append

func Append[T any](slices ...[]T) []T

Append concatenates multiple slices of strings into a single slice.

func Contains

func Contains[T comparable](a []T, x T) bool

Contains tells whether a contains x.

func Dedup

func Dedup[T comparable](arr []T) []T

func DeleteEmptyStrings

func DeleteEmptyStrings(s []string) []string

func Find

func Find(a []string, x string) int

Find returns the smallest index i at which x == a[i], or len(a) if there is no such index.

func IniToMap

func IniToMap(path string) map[string]string

IniToMap takes the path to an INI formatted file and transforms it into a map

func KeyValueSliceToMap

func KeyValueSliceToMap(in []string) map[string]string

KeyValueSliceToMap takes in a list of strings in a=b format and returns a map from it.

Any string that's not in a=b format will be ignored.

func MapKeys

func MapKeys[K comparable, T any](m map[K]T) []K

func MapToIni

func MapToIni(Map map[string]string) string

MapToIni takes a map and converts it into an INI formatted string

func MatchItems

func MatchItems(item string, items ...string) bool

matchItems returns true if any of the items in the list match the item. negative matches are supported by prefixing the item with a "!". * matches everything to match prefix and suffix use "*" accordingly.

func MergeMap

func MergeMap[T1 comparable, T2 any](a, b map[T1]T2) map[T1]T2

MergeMap will merge map b into a. On key collision, map b takes precedence.

func MergeStructs

func MergeStructs[T any](base, patch T) (T, error)

MergeStructs merges two structs where patch is applied on top of base

func ReplaceAllInSlice

func ReplaceAllInSlice(a []string, find string, replacement string) (replaced []string)

ReplaceAllInSlice runs strings.Replace on all elements in a slice and returns the result

func SelectorToMap

func SelectorToMap(selector string) (matchLabels map[string]string)

SelectorToMap returns a map from a selector string. i.e. "a=b,c=d" -> {"a": "b", "c": "d"}

func SortedMap

func SortedMap(m map[string]string) string

SortedMap takes a map and returns a sorted key value string i.e. {"a": "b", "c": "d"} -> "a=b,c=d"

func SplitAllInSlice

func SplitAllInSlice(a []string, split string, index int) (replaced []string)

SplitAllInSlice runs strings.Split on all elements in a slice and returns the results at the given index

func StructToIni

func StructToIni(s interface{}) string

StructToIni takes an object and serializes it's fields in INI format

func StructToJSON

func StructToJSON(v any) (string, error)

StructToJSON takes an object and returns its json form

func StructToMap

func StructToMap(s interface{}) map[string]interface{}

StructToMap takes an object and returns all it's field in a map

func ToBase64Map

func ToBase64Map(m map[string]interface{}) map[string]string

ToBase64Map converts a map[string]interface{} to a map[string]string by converting []byte to base64

func ToByteMap

func ToByteMap(m map[string]interface{}) map[string][]byte

ToByteMap converts a map[string]interface{} to a map[string]string by converting []byte to base64

func ToGenericMap

func ToGenericMap(m map[string]string) map[string]interface{}

ToGenericMap converts a map[string]string to a map[string]interface{}

func ToString

func ToString(i interface{}) string

ToString takes an object and tries to convert it to a string

func ToStringMap

func ToStringMap(m map[string]interface{}) map[string]string

ToStringMap converts a map[string]interface{} to a map[string]string by using each objects String() fn

Types

type Equals

type Equals[T any] interface {
	Equals(T) bool
}

type MetricsOpts

type MetricsOpts[T comparable] struct {
	Labels          map[string]any
	Labeller        map[string]func(i T) string
	DurationBuckets []float64
	Name            string
	Disable         bool
}

MetricsOpts contains options for queue metrics

type Queue

type Queue[T comparable] struct {
	Comparator utils.Comparator[T]
	Equals     func(a, b T) bool

	Dedupe bool
	// contains filtered or unexported fields
}

Queue holds elements in an array-list

func NewQueue

func NewQueue[T comparable](opts QueueOpts[T]) (*Queue[T], error)

func (*Queue[T]) Clear

func (queue *Queue[T]) Clear()

Clear removes all elements from the queue.

func (*Queue[T]) Dequeue

func (queue *Queue[T]) Dequeue() (T, bool)

Dequeue removes first element of the queue and returns it, or nil if queue is empty. Second return parameter is true, unless the queue was empty and there was nothing to dequeue.

func (*Queue[T]) Empty

func (queue *Queue[T]) Empty() bool

Empty returns true if queue does not contain any elements.

func (*Queue[T]) Enqueue

func (queue *Queue[T]) Enqueue(value T)

Enqueue adds a value to the end of the queue

func (*Queue[T]) EnqueueWithDelay

func (queue *Queue[T]) EnqueueWithDelay(value T, delay time.Duration)

Enqueue adds a value to the end of the queue

func (*Queue[T]) Iterator

func (queue *Queue[T]) Iterator() iter.Seq[T]

Iterator returns a new iterator for the queue.

func (*Queue[T]) Peek

func (queue *Queue[T]) Peek() (value T, ok bool)

Peek returns top element on the queue without removing it, or nil if queue is empty. Second return parameter is true, unless the queue was empty and there was nothing to peek.

func (*Queue[T]) Size

func (queue *Queue[T]) Size() int

Size returns number of elements within the queue.

func (*Queue[T]) String

func (queue *Queue[T]) String() string

String returns a string representation of container

func (*Queue[T]) Values

func (queue *Queue[T]) Values() []T

Values returns all elements in the queue.

type QueueOpts

type QueueOpts[T comparable] struct {
	Comparator utils.Comparator[T]
	Dedupe     bool
	Equals     func(a, b T) bool
	Metrics    MetricsOpts[T]
}