stringmap

Documentation

Overview

Package stringmap contains utilities to handle common map operations

Index

• func FromJson(j []byte) (out map[string]interface{}, err error)
• func FromJsonFile(f string) (out map[string]interface{}, err error)
• func GetBool(m map[string]interface{}, key string) (bool, bool)
• func GetJsonFloat(m map[string]interface{}, key string) (float64, bool)
• func GetJsonInt(m map[string]interface{}, key string) (int, bool)
• func GetString(m map[string]interface{}, key string) (string, bool)
• func JoinStrings(m map[string]string, kvSep string, itemSep string) (ret string)
• func Range[T any](m map[string]T, f func(key string, val T) bool)
• func SortedKeys[T any](m map[string]T) []string
• func ToStringStringMap(in map[string]interface{}) map[string]string

Examples

• SortedKeys

Functions

func FromJson

func FromJson(j []byte) (out map[string]interface{}, err error)

Converts a json map to a stringmap Integers come through as float64, so must be converted to int to be used

func FromJsonFile

func FromJsonFile(f string) (out map[string]interface{}, err error)

func GetBool

func GetBool(m map[string]interface{}, key string) (bool, bool)

GetBool gets a boolean out of a map of interfaces keyed by a string. Returns the bool and true if found, or false and false if not, or the found item was not a bool.

func GetJsonFloat

func GetJsonFloat(m map[string]interface{}, key string) (float64, bool)

GetJsonFloat gets a float64 out of a map of interfaces that were unmarshalled from json. Json unmarshalling creates json numbers, and these have to be coerced into integers or floats. Returns an int and true if found, and a zero and false if not, or the found item was not a coercible number.

func GetJsonInt

func GetJsonInt(m map[string]interface{}, key string) (int, bool)

GetJsonInt gets an integer out of a map of interfaces that were unmarshalled from json. Json unmarshalling creates json numbers, and these have to be coerced into integers or floats. Returns an int and true if found, and a zero and false if not, or the found item was not a coercible number.

func GetString

func GetString(m map[string]interface{}, key string) (string, bool)

GetString gets a string out of a map of interfaces keyed by a string. Returns the string and true if found, or an empty string and false if not, or the found item was not a string.

func JoinStrings

func JoinStrings(m map[string]string, kvSep string, itemSep string) (ret string)

JoinStrings will join a map[string]string with kvSep in between each key and value, and itemSep in between each group of those

func Range

func Range[T any](m map[string]T, f func(key string, val T) bool)

Range is a convenience method to range over any map that uses strings as keys in a predictable order from lowest to highest. It uses a similar Range type function to the sync.StdMap.Range function.

func SortedKeys

func SortedKeys[T any](m map[string]T) []string

SortedKeys returns the keys of any map that uses strings as keys, sorted alphabetically.

Example

m := map[string]int{
	"One":   1,
	"Two":   2,
	"Three": 3,
}

k := SortedKeys(m)
fmt.Print(k)

Output:

[One Three Two]

func ToStringStringMap

func ToStringStringMap(in map[string]interface{}) map[string]string

ToStringStringMap converts a map[string]interface{} to map[string]string. Any items in the incoming map that are not strings are ignored.