byteskey

Documentation

Index

• type CopyFn
• type EqualsFn
• type FinalizeFn
• type HashFn
• type Map
  • func NewMap(opts MapOptions) *Map
  • func (m *Map) Contains(k []byte) bool
  • func (m *Map) Delete(k []byte)
  • func (m *Map) Get(k []byte) (MapValue, bool)
  • func (m *Map) Iter() map[MapHash]MapEntry
  • func (m *Map) Len() int
  • func (m *Map) Reallocate()
  • func (m *Map) Reset()
  • func (m *Map) Set(k []byte, v MapValue)
  • func (m *Map) SetUnsafe(k []byte, v MapValue, opts SetUnsafeOptions)
• type MapEntry
  • func (e MapEntry) Key() []byte
  • func (e MapEntry) Value() MapValue
• type MapHash
• type MapOptions
• type MapValue
• type SetUnsafeOptions

Types

type CopyFn

type CopyFn func([]byte) []byte

CopyFn is the copy key function to execute when copying the key.

type EqualsFn

type EqualsFn func([]byte, []byte) bool

EqualsFn is the equals key function to execute when detecting equality of a key.

type FinalizeFn

type FinalizeFn func([]byte)

FinalizeFn is the finalize key function to execute when finished with a key.

type HashFn

type HashFn func([]byte) MapHash

HashFn is the hash function to execute when hashing a key.

type Map

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

Map uses the genny package to provide a generic hash map that can be specialized by running the following command from this root of the repository: ``` make hashmap-gen pkg=outpkg key_type=Type value_type=Type out_dir=/tmp ``` Or if you would like to use bytes or ident.ID as keys you can use the partially specialized maps to generate your own maps as well: ``` make byteshashmap-gen pkg=outpkg value_type=Type out_dir=/tmp make idhashmap-gen pkg=outpkg value_type=Type out_dir=/tmp ``` This will output to stdout the generated source file to use for your map. It uses linear probing by incrementing the number of the hash created when hashing the identifier if there is a collision. Map is a value type and not an interface to allow for less painful upgrades when adding/removing methods, it is not likely to need mocking so an interface would not be super useful either.

func NewMap

func NewMap(opts MapOptions) *Map

NewMap returns a new byte keyed map.

func (*Map) Contains

func (m *Map) Contains(k []byte) bool

Contains returns true if value exists for key, false otherwise, it is shorthand for a call to Get that doesn't return the value.

func (*Map) Delete

func (m *Map) Delete(k []byte)

Delete will remove a value set in the map for the specified key.

func (*Map) Get

func (m *Map) Get(k []byte) (MapValue, bool)

Get returns a value in the map for an identifier if found.

func (*Map) Iter

func (m *Map) Iter() map[MapHash]MapEntry

Iter provides the underlying map to allow for using a native Go for loop to iterate the map, however callers should only ever read and not write the map.

func (*Map) Len

func (m *Map) Len() int

Len returns the number of map entries in the map.

func (*Map) Reallocate

func (m *Map) Reallocate()

Reallocate will avoid deleting all keys and reallocate a new map, this is useful if you believe you have a large map and will not need to grow back to a similar size.

func (*Map) Reset

func (m *Map) Reset()

Reset will reset the map by simply deleting all keys to avoid allocating a new map.

func (*Map) Set

func (m *Map) Set(k []byte, v MapValue)

Set will set the value for an identifier.

func (*Map) SetUnsafe

func (m *Map) SetUnsafe(k []byte, v MapValue, opts SetUnsafeOptions)

SetUnsafe will set the value for an identifier with unsafe options for how the map treats the key.

type MapEntry

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

MapEntry is an entry in the map, this is public to support iterating over the map using a native Go for loop.

func (MapEntry) Key

func (e MapEntry) Key() []byte

Key returns the map entry key.

func (MapEntry) Value

func (e MapEntry) Value() MapValue

Value returns the map entry value.

type MapHash

type MapHash uint64

MapHash is the hash for a given map entry, this is public to support iterating over the map using a native Go for loop.

type MapOptions

type MapOptions struct {
	InitialSize int
	KeyCopyPool pool.BytesPool
}

MapOptions provides options used when created the map.

type MapValue

type MapValue generic.Type

MapValue is the generic type that needs to be specified when generating.

type SetUnsafeOptions

type SetUnsafeOptions struct {
	NoCopyKey     bool
	NoFinalizeKey bool
}

SetUnsafeOptions is a set of options to use when setting a value with the SetUnsafe method.