go-ordered-dict

Installation

go get github.com/amoolaa/go-ordered-dict

Usage

Basic Operations

package main
import (
 "fmt"
 "github.com/amoolaa/go-ordered-dict"
)
func main() {
 // Create a new ordered dictionary
 dict := ordereddict.New[string, int]()
 // Add items
 dict.Set("first", 1)
 dict.Set("second", 2)
 dict.Set("third", 3)
 // Get items
 if val, ok := dict.Get("second"); ok {
 fmt.Println(val) // Output: 2
 }
 // Check if key exists
 if dict.Has("first") {
 fmt.Println("Key exists")
 }
 // Get length
 fmt.Println(dict.Len()) // Output: 3
 // Delete items
 if val, ok := dict.Delete("second"); ok {
 fmt.Println("Deleted:", val)
 }
 // Pretty print the dictionary
 fmt.Println(dict) // Output: OrderedDict[first:1 third:3]
}

Pretty Printing

dict := ordereddict.New[string, int]()
dict.Set("apple", 1)
dict.Set("banana", 2)
dict.Set("cherry", 3)
fmt.Println(dict) // Output: OrderedDict[apple:1 banana:2 cherry:3]
fmt.Printf("Dict: %v\n", dict) // Also works with Printf

Iterating Over Items

// Get all keys in insertion order
keys := dict.Keys()
fmt.Println(keys) // ["first", "third"]
// Get all values in insertion order
values := dict.Values()
fmt.Println(values) // [1, 3]
// Using iterator (Go 1.23+)
for key, val := range dict.All() {
 fmt.Printf("%s: %d\n", key, val)
}

Reordering Items

dict := ordereddict.New[string, string]()
dict.Set("a", "first")
dict.Set("b", "second")
dict.Set("c", "third")
// Move to end
dict.MoveToEnd("a")
fmt.Println(dict.Keys()) // ["b", "c", "a"]
// Move to start
dict.MoveToStart("c")
fmt.Println(dict.Keys()) // ["c", "b", "a"]
// Move after another key
dict.MoveAfter("c", "a")
fmt.Println(dict.Keys()) // ["b", "a", "c"]

Pre-allocating Capacity

// Create dictionary with pre-allocated capacity
dict := ordereddict.NewWithCapacity[string, int](100)

Features