module RateLimiter::LimiterLike

Overview

Defines the API for a rate-limiter-like instance.

Direct including types

• RateLimiter::Limiter
• RateLimiter::MultiLimiter

Defined in:

rate_limiter.cr

Instance Method Summary

• #get(max_wait : Time::Span) : Token | Timeout

  Returns a Token if one is available within max_wait time, otherwise it returns a Timeout.

• #get : Token

  Returns a Token as soon as available.

• #get!(max_wait : Time::Span) : Token

  Raises RateLimiter::Timeout if no token is available after the given time span.

• #get! : Token

  Raises RateLimiter::Timeout if no token is available at call time.

• #get? : Token?

  Returns nil if no token is available at call time.

Instance Method Detail