randommap

Documentation

Index

• type RandomMap
  • func New() *RandomMap
  • func (rmap *RandomMap) Delete(key interface{}) (result interface{}, exists bool)
  • func (rmap *RandomMap) ForEach(consumer func(key interface{}, value interface{}))
  • func (rmap *RandomMap) Get(key interface{}) (result interface{}, exists bool)
  • func (rmap *RandomMap) Keys() (result []interface{})
  • func (rmap *RandomMap) RandomEntry() (result interface{})
  • func (rmap *RandomMap) RandomKey() (result interface{})
  • func (rmap *RandomMap) RandomUniqueEntries(count int) (results []interface{})
  • func (rmap *RandomMap) Set(key interface{}, value interface{}) (updated bool)
  • func (rmap *RandomMap) Size() (result int)

Types

type RandomMap

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

RandomMap defines a map with extended ability to return a random entry.

func New

func New() *RandomMap

New creates a new random map

func (*RandomMap) Delete

func (rmap *RandomMap) Delete(key interface{}) (result interface{}, exists bool)

Delete removes the mapping for the specified key in the map.

func (*RandomMap) ForEach

func (rmap *RandomMap) ForEach(consumer func(key interface{}, value interface{}))

ForEach iterates through the elements in the map and calls the consumer function for each element.

func (*RandomMap) Get

func (rmap *RandomMap) Get(key interface{}) (result interface{}, exists bool)

Get returns the value to which the specified key is mapped.

func (*RandomMap) Keys

func (rmap *RandomMap) Keys() (result []interface{})

Keys returns the list of keys stored in the RandomMap.

func (*RandomMap) RandomEntry

func (rmap *RandomMap) RandomEntry() (result interface{})

RandomEntry returns a random value from the map.

func (*RandomMap) RandomKey

func (rmap *RandomMap) RandomKey() (result interface{})

RandomKey returns a random key from the map.

func (*RandomMap) RandomUniqueEntries

func (rmap *RandomMap) RandomUniqueEntries(count int) (results []interface{})

RandomUniqueEntries returns n random and unique values from the map. When count is equal or bigger than the size of the random map, the every entry in the map is returned.

func (*RandomMap) Set

func (rmap *RandomMap) Set(key interface{}, value interface{}) (updated bool)

Set associates the specified value with the specified key. If the association already exists, it updates the value.

func (*RandomMap) Size

func (rmap *RandomMap) Size() (result int)

Size returns the number of key-value mappings in the map.