orderedmap · pkg.go.dev

README

Implementation of an insertion ordered map in Go

go get go.bmvs.io/orderedmap

package main

import (
	"go.bmvs.io/orderedmap"
)

func main() {
	m := orderedmap.New()
	m.Put("foo", "bar")
	// ...
}

See the godoc to see all the available methods with example usage.

BSD-2-Clause

Package orderedmap implements a thread safe insertion ordered map.

This section is empty.

This section is empty.

This section is empty.

type OrderedMap struct {
	sync.Mutex
	// contains filtered or unexported fields
}

OrderedMap insertion ordered Map implementation

func New() *OrderedMap

New return a new Map implemented by OrderedMap

func (m *OrderedMap) Empty() bool

Empty return if the OrderedMap in empty or not

func (m *OrderedMap) Get(key interface{}) (value interface{}, found bool)

Get return the value of a key from the OrderedMap

func (m *OrderedMap) Keys() []interface{}

Keys return the keys of the OrderedMap in insertion order

func (m *OrderedMap) Put(key, value interface{})

Put add a key-value pair to the OrderedMap

func (m *OrderedMap) Remove(key interface{})

Remove remove a key-value pair from the OrderedMap

func (m *OrderedMap) Size() int

Size return the size of the OrderedMap

func (m *OrderedMap) Values() []interface{}

Values return the values of the OrderedMap in insertion order

View all