Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
- API
  
  Reference documentation for the pkg.go.dev API
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

orderedmap

package module

Go to main page

Versions in this module

v2

v2.3.2

Sep 25, 2026

v2.3.1

Mar 24, 2026

v2.3.0

Sep 12, 2025

v2.2.0

Aug 4, 2025

v2.1.12

Aug 4, 2025

Changes in this version

+ type InitOption func(config *initConfig[K, V])

+ func WithCapacity[K comparable, V any](capacity int) InitOption[K, V]

+ func WithDisableHTMLEscape[K comparable, V any]() InitOption[K, V]

+ func WithInitialData[K comparable, V any](initialData ...Pair[K, V]) InitOption[K, V]

+ type KeyNotFoundError struct

+ MissingKey K

+ func (e *KeyNotFoundError[K]) Error() string

+ type OrderedMap struct

+ func From[K comparable, V any](i iter.Seq2[K, V]) *OrderedMap[K, V]

+ func New[K comparable, V any](options ...any) *OrderedMap[K, V]

+ func (om *OrderedMap[K, V]) AddPairs(pairs ...Pair[K, V])

+ func (om *OrderedMap[K, V]) Delete(key K) (val V, present bool)

+ func (om *OrderedMap[K, V]) Filter(predicate func(K, V) bool)

+ func (om *OrderedMap[K, V]) FromNewest() iter.Seq2[K, V]

+ func (om *OrderedMap[K, V]) FromOldest() iter.Seq2[K, V]

+ func (om *OrderedMap[K, V]) Get(key K) (val V, present bool)

+ func (om *OrderedMap[K, V]) GetAndMoveToBack(key K) (val V, err error)

+ func (om *OrderedMap[K, V]) GetAndMoveToFront(key K) (val V, err error)

+ func (om *OrderedMap[K, V]) GetPair(key K) *Pair[K, V]

+ func (om *OrderedMap[K, V]) KeysFromNewest() iter.Seq[K]

+ func (om *OrderedMap[K, V]) KeysFromOldest() iter.Seq[K]

+ func (om *OrderedMap[K, V]) Len() int

+ func (om *OrderedMap[K, V]) Load(key K) (V, bool)

+ func (om *OrderedMap[K, V]) MarshalJSON() ([]byte, error)

+ func (om *OrderedMap[K, V]) MarshalYAML() (interface{}, error)

+ func (om *OrderedMap[K, V]) MoveAfter(key, markKey K) error

+ func (om *OrderedMap[K, V]) MoveBefore(key, markKey K) error

+ func (om *OrderedMap[K, V]) MoveToBack(key K) error

+ func (om *OrderedMap[K, V]) MoveToFront(key K) error

+ func (om *OrderedMap[K, V]) Newest() *Pair[K, V]

+ func (om *OrderedMap[K, V]) Oldest() *Pair[K, V]

+ func (om *OrderedMap[K, V]) Set(key K, value V) (val V, present bool)

+ func (om *OrderedMap[K, V]) Store(key K, value V) (V, bool)

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

+ func (om *OrderedMap[K, V]) UnmarshalYAML(value *yaml.Node) error

+ func (om *OrderedMap[K, V]) Value(key K) (val V)

+ func (om *OrderedMap[K, V]) ValuesFromNewest() iter.Seq[V]

+ func (om *OrderedMap[K, V]) ValuesFromOldest() iter.Seq[V]

+ type Pair struct

+ Key K

+ Value V

+ func (p *Pair[K, V]) Next() *Pair[K, V]

+ func (p *Pair[K, V]) Prev() *Pair[K, V]

Other modules containing this package

github.com/pb33f/ordered-map