maps

package module

v0.0.0-...-fec0ade Latest Latest Go to latest Published: Jan 4, 2023 License: MIT Imports: 2 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/0x9ef/go-maps

Links

Open Source Insights

README ¶

Go maps

It's modern package that based on generic maps. The package provides many helpers to operate on thread-safe (only) maps. You don't have to worry about the concurrency moment of this map. Under the hood, realization is based on sync.Map.

Installation

go get github.com/0x9ef/go-maps

Usage

import "github.com/0x9ef/go-maps"

DefaultMap

We can start from the native map realisation.

Set

We can set map key with a value.

m := maps.NewDefaultMap[string, int]()
m.Set("one", 1) // sets for key "one" value "1"

SetIf

We can set map key with a value if predicate function is true.

m := maps.NewDefaultMap[string, int]()
m.Set("ten", 10)
m.SetIf("one", 1, func(m Map[int, int]) bool {
	return m.Get("ten") == 10 // sets only if "ten" key is equals to 10
})

Get

We can get a map value.

m := maps.NewDefaultMap[string, int]()
m.Set("one", 1)
val := m.Get("one")
if val == 1 { 
    fmt.Println("found")
}

GetOk

We can get a value and identifier if a record was found.

m := maps.NewDefaultMap[string, int]()
val, ok := m.GetOk("one")
if !ok {
    fmt.Println("key was not found")
}

GetOrSet

We can get a value or if value was not found we have to store it.

m := maps.NewDefaultMap[string, int]()
val, loaded := m.GetOrSet("one", 1)
if !loaded {
    fmt.Println("key was not found, but we store it")
}
fmt.Println(val)
// 1

GetAndDelete

We can get a value and after this delete this value from the map.

m := maps.NewDefaultMap[string, int]()
m.Set("one", 1)
val, loaded := m.GetAndDelete("one")
if !loaded {
    fmt.Println("key was not found, we didn't delete it")
}
fmt.Println(val)
// 1

Delete

We can delete a key from the map.

m := maps.NewDefaultMap[string, int]()
m.Set("one", 1)
m.Delete("one")

DeleteIf

We can delete a key from the map if predicate function is true.

m := maps.NewDefaultMap[string, int]()
m.Set("one", 1)
m.DeleteIf("one", func(m Map[int, int]) bool {
	return !m.Exists("ten") // deletes value only if key "ten" doesn't exists
})

Clear

We can clear full map, so this means that we can delete all keys from the map.

m := maps.NewDefaultMap[string, int]()
m.Set("one", 1)
m.Set("two", 2)
m.Set("three", 3)
m.Clear()

Keys

We can get all keys from the map.

m := maps.NewDefaultMap[string, int]()
m.Set("one", 1)
m.Set("two", 2)
m.Set("three", 3)
fmt.Println(m.Keys())
// ["one", "two", "three"]

Values

We can get all values from the map.

m := maps.NewDefaultMap[string, int]()
m.Set("one", 1)
m.Set("two", 2)
m.Set("three", 3)
fmt.Println(m.Values())
// [1, 2, 3]

Filter

We can filter map content and return only keys and values that was matched by our rules.

m := maps.NewDefaultMap[string, int]()
m.Set("one", 1)
m.Set("two", 2)
m.Set("three", 3)
m.Set("four", 3)
keys, values := m.Filter(func(key string,  value int) bool {
	return key == "three" && value == 3 // we match third element in the map
})
fmt.Println(keys, values)
// ["three"], [1]

Iterate

We can iterate over all keys in the map

m := maps.NewDefaultMap[string, int]()
m.Set("one", 1)
m.Set("two", 2)
m.Set("three", 3)
m.Iterate(func(key string, value int) bool{
    fmt.Println(key, value)
})
// "one" 1
// "two" 2
// "three" 3

License

MIT

Documentation ¶

Overview ¶

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: