orderedmap

README

Golang Ordered Map

Golang Ordered Map is a map data structure that maintains the order of the keys. It also supports JSON and YAML marshalling.

Installation

go get github.com/nicolasparada/go-ordered-map

Usage

package main

import (
	orderedmap "github.com/nicolasparada/go-ordered-map"
)

func main() {
	data := []byte(`{ "name": "John", "age": 30, "active": true }`)

	var unordered map[string]any{}
	if err := json.Unmarshal(data, &unordered); err != nil {
		panic(err)
	}

	var ordered orderedmap.OrderedMap[string, any]
	if err := json.Unmarshal(data, &ordered); err != nil {
		panic(err)
	}

	json.NewEncoder(os.Stdout).Encode(unordered) // will print in undefined order
	json.NewEncoder(os.Stdout).Encode(ordered) // will always print: {"name":"John","age":30,"active":true}
}

Documentation

Index

• type OrderedMap
  • func New[K comparable, V any]() OrderedMap[K, V]
  • func (m *OrderedMap[K, V]) Clear()
  • func (m OrderedMap[K, V]) Clone() OrderedMap[K, V]
  • func (m OrderedMap[K, V]) DeepCopyInto(out *OrderedMap[K, V])
  • func (m *OrderedMap[K, V]) Delete(key K)
  • func (m OrderedMap[K, V]) Equal(other OrderedMap[K, V]) bool
  • func (m OrderedMap[K, V]) Get(key K) (V, bool)
  • func (m OrderedMap[K, V]) Has(key K) bool
  • func (m OrderedMap[K, V]) Keys() []K
  • func (o OrderedMap[K, V]) MarshalJSON() ([]byte, error)
  • func (pp OrderedMap[K, V]) MarshalYAML() (any, error)
  • func (m *OrderedMap[K, V]) Set(key K, val V)
  • func (o *OrderedMap[K, V]) UnmarshalJSON(data []byte) error
  • func (pp *OrderedMap[K, V]) UnmarshalYAML(node *yaml.Node) error
  • func (m OrderedMap[K, V]) Values() []V
• type Pair
  • func (p Pair[K, V]) Equal(other Pair[K, V]) bool

Types

type OrderedMap

type OrderedMap[K comparable, V any] []Pair[K, V]

func New

func New[K comparable, V any]() OrderedMap[K, V]

func (*OrderedMap[K, V]) Clear

func (m *OrderedMap[K, V]) Clear()

func (OrderedMap[K, V]) Clone

func (m OrderedMap[K, V]) Clone() OrderedMap[K, V]

func (OrderedMap[K, V]) DeepCopyInto

func (m OrderedMap[K, V]) DeepCopyInto(out *OrderedMap[K, V])

func (*OrderedMap[K, V]) Delete

func (m *OrderedMap[K, V]) Delete(key K)

func (OrderedMap[K, V]) Equal

func (m OrderedMap[K, V]) Equal(other OrderedMap[K, V]) bool

func (OrderedMap[K, V]) Get

func (m OrderedMap[K, V]) Get(key K) (V, bool)

func (OrderedMap[K, V]) Has

func (m OrderedMap[K, V]) Has(key K) bool

func (OrderedMap[K, V]) Keys

func (m OrderedMap[K, V]) Keys() []K

func (OrderedMap[K, V]) MarshalJSON

func (o OrderedMap[K, V]) MarshalJSON() ([]byte, error)

MarshalJSON implements json.Marshaler interface to marshall a sorted list of key-value pairs into an object.

func (OrderedMap[K, V]) MarshalYAML

func (pp OrderedMap[K, V]) MarshalYAML() (any, error)

MarshalYAML implements yaml.Marshaler interface to marshall a sorted list of properties into an object.

func (*OrderedMap[K, V]) Set

func (m *OrderedMap[K, V]) Set(key K, val V)

func (*OrderedMap[K, V]) UnmarshalJSON

func (o *OrderedMap[K, V]) UnmarshalJSON(data []byte) error

UnmarshalJSON implements json.Unmarshaler interface to unmarshal an object into a sorted list of key-value pairs.

func (*OrderedMap[K, V]) UnmarshalYAML

func (pp *OrderedMap[K, V]) UnmarshalYAML(node *yaml.Node) error

UnmarshalYAML implements yaml.Unmarshaler interface to unmarshal an object into a sorted list of properties.

func (OrderedMap[K, V]) Values

func (m OrderedMap[K, V]) Values() []V

type Pair

type Pair[K comparable, V any] struct {
	Key K
	Val V
}

func (Pair[K, V]) Equal

func (p Pair[K, V]) Equal(other Pair[K, V]) bool