Ordered map

Omap is Golang package for working with thread safe ordered maps. The ordered map contains the golang map, list and mutex to execute Ordered Map functions.

The Ordered Map is a map that remembers the order of items. The map can be iterated over to retrieve the items in the order they were added.

Introduction to the omap Go Package

The omap Go package is a lightweight and efficient library for working with ordered maps in Go. An ordered map is a data structure that combines the benefits of a map and a list, allowing you to store key-value pairs in a specific order.

What is omap?

Omap is a Go package that provides an implementation of an ordered map. It is designed to be fast, efficient, and easy to use. Omap is particularly useful when you need to store data in a specific order, such as when working with configuration files, caching, or data processing pipelines.

Key Features of omap

• Ordered: omap preserves the order in which key-value pairs are inserted, allowing you to iterate over the map in a specific order.

• Fast lookups: omap uses a hash table to store key-value pairs, making lookups fast and efficient.

• Efficient insertion and deletion: omap uses a linked list to store the order of key-value pairs, making insertion and deletion operations efficient.

Using omap

To use omap, you can install it using the following command:

go get github.com/kirill-scherba/omap

Here is an example of how to use omap:

package main

import (
    "fmt"
    "log"

    "github.com/kirill-scherba/omap"
)

func main() {
    // Create a new ordered map
    m, err := omap.New[string, string]()
    if err != nil {
        log.Fatal(err)
    }

    // Insert some key-value pairs
    m.Set("key1", "value1")
    m.Set("key2", "value2")
    m.Set("key3", "value3")

    // Iterate over the omap in order
    for _, pair := range m.Pairs() {
        fmt.Printf("%s: %s\n", pair.Key, pair.Value)
    }
}

This code creates a new omap, inserts some key-value pairs, and then iterates over the omap in order, printing out each key-value pair.

Conclusion

The omap Go package is a useful library for working with ordered maps in Go. Its fast lookups, efficient insertion and deletion, and ordered iteration make it a great choice for a variety of use cases. Whether you're working with configuration files, caching, or data processing pipelines, omap is definitely worth considering.

Example Use Cases

• Configuration files: Use omap to store configuration data in a specific order, making it easy to iterate over the configuration and apply settings in the correct order.

• Caching: Use omap to store cached data in a specific order, making it easy to iterate over the cache and evict items in the correct order.

• Data processing pipelines: Use omap to store data in a specific order, making it easy to iterate over the data and process it in the correct order.

See more description and examples on omap projects github page:
https://github.com/kirill-scherba/omap/