glru

README

Glru

A Simple Concurrent Safe LRU implementation in Golang.

Installation

go get github.com/ArunMurugan78/glru

Documentation

Overview

package glru encapsulates logic for the LRU cache.

Index

• Constants
• Variables
• type Config
• type Glru
  • func New(config Config) *Glru
  • func (cache *Glru) DeleteKey(key string)
  • func (cache *Glru) Get(key string) (interface{}, error)
  • func (cache *Glru) Set(key string, value interface{})

Constants

const DEFAULT_MAX_ITEMS = 10000

Variables

var ErrKeyNotFound = errors.New("key not found")

ErrKeyNotFound is returned by Get method when the key is not found.

Types

type Config

type Config struct {
	MaxItems int // Defaults to DEFAULT_MAX_ITEMS
}

Config is passed to New().

type Glru

type Glru struct {
	// contains filtered or unexported fields
}

Glru is the main struct which implements the LRU cache.

func New

func New(config Config) *Glru

New returns a new initialized Glru instance.

func (*Glru) DeleteKey

func (cache *Glru) DeleteKey(key string)

func (*Glru) Get

func (cache *Glru) Get(key string) (interface{}, error)

Get returns the value association with the key. Returns ErrKeyNotFound if the key is not found in cache.

func (*Glru) Set

func (cache *Glru) Set(key string, value interface{})

Set adds the key-value pair to the cache.