Add Limit.String

Author: vmihailenco

rate.go

@@ -2,6 +2,7 @@ package redis_rate
 
 import (
 	"context"
+	"fmt"
 	"strconv"
 	"time"
 
@@ -23,6 +24,22 @@ type Limit struct {
 	Burst  int
 }
 
+func (l *Limit) String() string {
+	return fmt.Sprintf("%d req/%s (burst %d)", l.Rate, fmtDur(l.Period), l.Burst)
+}
+
+func fmtDur(d time.Duration) string {
+	switch d {
+	case time.Second:
+		return "s"
+	case time.Minute:
+		return "m"
+	case time.Hour:
+		return "h"
+	}
+	return d.String()
+}
+
 func PerSecond(rate int) *Limit {
 	return &Limit{
 		Rate:   rate,

rate_test.go

@@ -26,6 +26,7 @@ func TestAllow(t *testing.T) {
 
 	l := rateLimiter()
 	limit := redis_rate.PerSecond(10)
+	assert.Equal(t, limit.String(), "10 req/s (burst 10)")
 
 	res, err := l.Allow(ctx, "test_id", limit)
 	assert.Nil(t, err)