rate

Documentation

Index

• Constants
• Variables
• func EmojiRune(r rune) bool
• func ParseBucketKey(path string) string
• func StringIsCustomEmoji(emoji string) bool
• func StringIsEmojiOnly(emoji string) bool
• type CustomRateLimit
• type Limiter
  • func NewLimiter(prefix string) *Limiter
  • func (l *Limiter) Acquire(ctx context.Context, path string) error
  • func (l *Limiter) Cancel(path string) error
  • func (l *Limiter) Release(path string, headers http.Header) error

Constants

const ExtraDelay = 250 * time.Millisecond

ExtraDelay because Discord is trash. I've seen this in both litcord and discordgo, with dgo claiming from his experiments. RE: Those who want others to fix it for them: release the source code then.

Variables

var MajorRootPaths = []string{"channels", "guilds"}

TODO: webhook

Functions

func EmojiRune

func EmojiRune(r rune) bool

func ParseBucketKey

func ParseBucketKey(path string) string

func StringIsCustomEmoji

func StringIsCustomEmoji(emoji string) bool

func StringIsEmojiOnly

func StringIsEmojiOnly(emoji string) bool

Types

type CustomRateLimit

type CustomRateLimit struct {
	Contains string
	Reset    time.Duration
}

type Limiter

type Limiter struct {
	// Only 1 per bucket
	CustomLimits []*CustomRateLimit

	// These callbacks will only be called for valid buckets. They will also be
	// called right before locking. Returning false will not rate limit.
	OnAcquire func(path string) bool
	OnCancel  func(path string) bool
	OnRelease func(path string) bool // false means not unlocking

	Prefix string
	// contains filtered or unexported fields
}

func NewLimiter

func NewLimiter(prefix string) *Limiter

func (*Limiter) Acquire

func (l *Limiter) Acquire(ctx context.Context, path string) error

func (*Limiter) Cancel

func (l *Limiter) Cancel(path string) error

func (*Limiter) Release

func (l *Limiter) Release(path string, headers http.Header) error

Release releases the URL from the locks. This doesn't need a context for timing out, it doesn't block that much.