propmap

Documentation

Index

• func DebugSetType(pm Map, name string)
• func Delete(pm Map, key string)
• func Empty(pm Map) bool
• func ForEach(pm Map, f func(k, v string) error) error
• func Set[V any](pm Map, key string, value V)
• func SetDefault[V any](pm Map, key string, value V)
• func StringOr(pm Map, key string, def string) string
• func Value[V any](pm Map, key string, def V) (V, error)
• func ValueOr[V any](pm Map, key string, def V) (V, error)
• func ValueOrP[V any](pm Map, key string, def V, errp *error) V
• func ValueP[V any](pm Map, key string, def V, errp *error) V
• type Map
  • func New() Map
  • func (pm Map) Equal(other Map) bool
  • func (pm Map) Hash() (uint64, error)
  • func (pm Map) MarshalJSON() ([]byte, error)
  • func (pm *Map) UnmarshalJSON(data []byte) error
• type TriState
  • func (t TriState) MarshalText() ([]byte, error)
  • func (t *TriState) UnmarshalText(text []byte) error

Functions

func DebugSetType

func DebugSetType(pm Map, name string)

DebugSetType enables logging for the given map and annotates logs with the given name.

func Delete

func Delete(pm Map, key string)

Delete deletes a properties map entry.

func Empty

func Empty(pm Map) bool

Empty tells if the map is empty.

func ForEach

func ForEach(pm Map, f func(k, v string) error) error

ForEach iterates over a map.

func Set

func Set[V any](pm Map, key string, value V)

Set sets a properties map entry.

func SetDefault

func SetDefault[V any](pm Map, key string, value V)

SetDefault sets a properties map entry if not already set.

func StringOr

func StringOr(pm Map, key string, def string) string

StringOr returns the string value, or the given value if not found.

This is separate as this special case cannot ever fail.

func Value

func Value[V any](pm Map, key string, def V) (V, error)

Value returns the requested value, or fails if not found.

func ValueOr

func ValueOr[V any](pm Map, key string, def V) (V, error)

ValueOr returns the requested value, or the given value if not found.

func ValueOrP

func ValueOrP[V any](pm Map, key string, def V, errp *error) V

ValueOrP returns the requested value, or the given value if not found.

func ValueP

func ValueP[V any](pm Map, key string, def V, errp *error) V

ValueP returns the requested value, or fails if not found.

Types

type Map

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

Map is a helper to easier deal with maps.

func New

func New() Map

New creates a new map.

func (Map) Equal

func (pm Map) Equal(other Map) bool

func (Map) Hash

func (pm Map) Hash() (uint64, error)

func (Map) MarshalJSON

func (pm Map) MarshalJSON() ([]byte, error)

func (*Map) UnmarshalJSON

func (pm *Map) UnmarshalJSON(data []byte) error

type TriState

type TriState struct {
	Active bool
	Value  bool
}

func (TriState) MarshalText

func (t TriState) MarshalText() ([]byte, error)

func (*TriState) UnmarshalText

func (t *TriState) UnmarshalText(text []byte) error