xz

Documentation

Overview

Package xz implements internal utilities that mimics standard library counterparts.

Index

• type Map
  • func NewMap() (m *Map)
  • func (m *Map) Clear()
  • func (m *Map) Count() (n int)
  • func (m *Map) Delete(key interface{})
  • func (m *Map) Load(key interface{}) (value interface{}, ok bool)
  • func (m *Map) LoadOrStore(key, value interface{}) (actual interface{}, loaded bool)
  • func (m *Map) Range(f func(key, value interface{}) bool)
  • func (m *Map) Store(key, value interface{})

Types

type Map

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

Map follows the same interface of sync.Map and is safe for concurrent use, it is however targeted to the RW scenario and allocates much less.

func NewMap

func NewMap() (m *Map)

NewMap creates a new map with the specified shards count. If the shards argument is < 2, the DefaultShardCount will be used.

func (*Map) Clear

func (m *Map) Clear()

Clear the map contents but retains the allocated shards.

func (*Map) Count

func (m *Map) Count() (n int)

Count returns the number of entries in the map

func (*Map) Delete

func (m *Map) Delete(key interface{})

Delete deletes the value for a key.

func (*Map) Load

func (m *Map) Load(key interface{}) (value interface{}, ok bool)

Load returns the value stored in the map for a key, or nil if no value is present. The ok result indicates whether value was found in the map.

func (*Map) LoadOrStore

func (m *Map) LoadOrStore(key, value interface{}) (actual interface{}, loaded bool)

LoadOrStore returns the existing value for the key if present. Otherwise, it stores and returns the given value. The loaded result is true if the value was loaded, false if stored.

func (*Map) Range

func (m *Map) Range(f func(key, value interface{}) bool)

Range calls f sequentially for each key and value present in the map. If f returns false, range stops the iteration.

Range does not necessarily correspond to any consistent snapshot of the Map's contents: no key will be visited more than once, but if the value for any key is stored or deleted concurrently, Range may reflect any mapping for that key from any point during the Range call.

func (*Map) Store

func (m *Map) Store(key, value interface{})

Store sets the value for a key.