Exception: SpeedLimiter::Errors::LimitExceededError

Inherits:

StandardError

• Object
• StandardError
• SpeedLimiter::Errors::LimitExceededError

Extended by:

Forwardable

Defined in:

lib/speed_limiter/errors/limit_exceeded_error.rb

Overview

SpeedLimiter limit exceeded Base Error

Direct Known Subclasses

ThrottledError

Instance Attribute Summary

• #state ⇒ Object readonly

  Returns the value of attribute state.

Instance Method Summary

• #count ⇒ Object
• #error_message ⇒ Object
• #initialize(state) ⇒ LimitExceededError constructor

  A new instance of LimitExceededError.

• #key ⇒ Object
• #limit ⇒ Object
• #period ⇒ Object
• #ttl ⇒ Object

Constructor Details

#initialize(state) ⇒ LimitExceededError

Returns a new instance of LimitExceededError.

Parameters:

• state (SpeedLimiter::State)

# File 'lib/speed_limiter/errors/limit_exceeded_error.rb', line 12

def initialize(state)
  @state = state
  super(error_message)
end

Instance Attribute Details

#state ⇒ Object (readonly)

Returns the value of attribute state.

# File 'lib/speed_limiter/errors/limit_exceeded_error.rb', line 16

def state
  @state
end

Instance Method Details

#count ⇒ Object

See Also:

• State#count

# File 'lib/speed_limiter/errors/limit_exceeded_error.rb', line 28

delegate %i[key ttl count limit period] => :@state

#error_message ⇒ Object

# File 'lib/speed_limiter/errors/limit_exceeded_error.rb', line 30

def error_message
  "#{key} rate limit exceeded. Retry after #{ttl} seconds. limit=#{limit}, count=#{count}, period=#{period}"
end

#key ⇒ Object

See Also:

• State#key

# File 'lib/speed_limiter/errors/limit_exceeded_error.rb', line 28

delegate %i[key ttl count limit period] => :@state

#limit ⇒ Object

See Also:

• State#limit

# File 'lib/speed_limiter/errors/limit_exceeded_error.rb', line 28

delegate %i[key ttl count limit period] => :@state

#period ⇒ Object

See Also:

• State#period

# File 'lib/speed_limiter/errors/limit_exceeded_error.rb', line 28

delegate %i[key ttl count limit period] => :@state

#ttl ⇒ Object

See Also:

• State#ttl

# File 'lib/speed_limiter/errors/limit_exceeded_error.rb', line 28

delegate %i[key ttl count limit period] => :@state