GitHub

API reference for Limit.

Runs an effect after the consume it was made with, waiting the consume's delay first; an exceeded "fail" consume fails instead.

Functions

__init__

__init__(consume) -> None
ParameterTypeDescription
consumeEffect[ConsumeResult, RateLimiterError]
def __init__(self, consume: Effect[ConsumeResult, RateLimiterError]) -> None:
    self._consume = consume

__call__

__call__[A, E, R](effect) -> Effect[A, E | RateLimiterError, R]
ParameterTypeDescription
effectEffect[A, E, R]

Returns Effect[A, E | RateLimiterError, R]

def __call__[A, E, R](self, effect: Effect[A, E, R]) -> Effect[A, E | RateLimiterError, R]:
    require_effect(effect, "effect")

    def run(result: ConsumeResult) -> Effect[A, E, R]:
        return effect if result.delay.is_zero() else effect.delay(result.delay)

    return self._consume.flat_map(run)