redigo

README

redigo

An officially supported adapter compatible with redigo

Usage

package main

import (
	"log"

	"github.com/aidenwallis/go-ratelimiting/redis"
	"github.com/aidenwallis/go-ratelimiting/redis/adapters/redigo"
	redigo "github.com/gomodule/redigo/redis"
)

func main() {
	conn, err := redis.Dial("tcp", "127.0.0.1:6379")
	if err != nil {
		log.Fatalf("failed to connect to redis: %w", err)
	}

	ratelimiter := redis.NewLeakyBucket(redigo.NewAdapter(conn))
}

Documentation

Index

• type Adapter
  • func NewAdapter(conn redis.Conn) *Adapter
  • func (a *Adapter) Eval(ctx context.Context, script string, keys []string, args []interface{}) (interface{}, error)

Types

type Adapter

type Adapter struct {
	Conn redis.Conn
}

Adapter is a redigo implementation compatible with github.com/aidenwallis/go-ratelimiting/redis/adapters

func NewAdapter

func NewAdapter(conn redis.Conn) *Adapter

NewAdapter creates a new adapter using the redigo client.

func (*Adapter) Eval

func (a *Adapter) Eval(ctx context.Context, script string, keys []string, args []interface{}) (interface{}, error)

Eval defines adapter compatibility for the redis EVAL command