[API Proposal]: System.Threading.RateLimiting.RateLimiter.AcquireAsync(CancellationToken cancellationToken);

[TonyValenti]

Background and motivation

Acquiring one permit from a rate limiter and using a cancelation token is a common scenario. This should be built in to the core

API Proposal

namespace System.Threading.RateLimiting;

public class RateLimiter
{
    public ValueTask<RateLimitLease> AcquireAsync(CancellationToken cancellationToken);
}

API Usage

using var Lease = await RateLimiter.AcquireAsync(Token);

Alternative Designs

This could be implemented as an extension method.

Risks

No response

[dotnet-policy-service]

Tagging subscribers to this area: @mangod9
See info in area-owners.md if you want to be subscribed.