gofast's Introduction

gofast

gofast is a Go module that provides easy-to-use in-memory cache algorithms like LRU (Least Recently Used). It allows you to import and use these algorithms simply and directly in your Go projects.

Installation

Install gofast by simply using the go get command:

$ go get github.com/raghavgh/gofast

Usage

Importing the module

First, import gofast like this:

import "github.com/raghavgh/gofast"

Here is an example of how you can use the module:

type CacheRepo struct {
    MetaCache gofast.Cache
}

func NewCacheRepo() *CacheRepo {
    return &CacheRepo{
        // 1 is the algorithm type for LRU
        MetaCache: gofast.NewCache(1000, gofast.LRU),
    }
}

Available Functions

// Get returns the value (if any) and a boolean representing whether the value was found or not
Get(key string) (any, bool)
// Put adds a value to the cache
Put(key string, val any)
// Remove removes a value from the cache
Remove(key string)
// Len returns the number of elements of the cache
Len() int
// Clear clears the cache
Clear()
// Contains returns true if the cache contains the given key
Contains(key string) bool

**All above funtions are thread safe

Available Cache Algorithms

Currently, the following cache algorithms are available:

LRU (Least Recently Used)
LFU (Least Frequently Used)
LIFO (Last In, First Out)

More algorithms will be available in future versions.

Supported algorithms can be specified with the following constants:

gofast.LRU   // Least Recently Used algorithm
gofast.LFU   // Least Frequently Used algorithm
gofast.FIFO  // First In, First Out algorithm
gofast.MRU   // Most Recently Used algorithm
gofast.RR    // Random Replacement algorithm
gofast.SLRU  // Segmented Least Recently Used algorithm
gofast.LIFO  // Last In, First Out algorithm