Class RateLimitError

Namespace: FunctionalDdd

Assembly: FunctionalDdd.RailwayOrientedProgramming.dll

Represents a rate limiting error when too many requests have been made. Use this when a client has exceeded their request quota or rate limit. Maps to HTTP 429 Too Many Requests.

public sealed class RateLimitError : Error, IEquatable<Error>

Inheritance: object

Error

RateLimitError

Implements: IEquatable<Error>

Inherited Members: Error.Code

Error.Detail

Error.Instance

Error.Equals(Error)

Error.Equals(object)

Error.GetHashCode()

Error.ToString()

Error.Validation(string, string, string, string)

Error.Validation(ImmutableArray<ValidationError.FieldError>, string, string)

Error.Validation(ImmutableArray<ValidationError.FieldError>, string, string, string)

Error.BadRequest(string, string)

Error.Conflict(string, string)

Error.NotFound(string, string)

Error.Unauthorized(string, string)

Error.Forbidden(string, string)

Error.Unexpected(string, string)

Error.Domain(string, string)

Error.RateLimit(string, string)

Error.ServiceUnavailable(string, string)

Error.BadRequest(string, string, string)

Error.Conflict(string, string, string)

Error.NotFound(string, string, string)

Error.Unauthorized(string, string, string)

Error.Forbidden(string, string, string)

Error.Unexpected(string, string, string)

Error.Domain(string, string, string)

Error.RateLimit(string, string, string)

Error.ServiceUnavailable(string, string, string)

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Extension Methods: CombineErrorExtensions.Combine(Error?, Error)

MaybeExtensions.AsMaybe<T>(T)

MaybeExtensions.ToResult<TValue>(TValue)

NullableExtensions.ToResult<T>(T?, Error)

Examples

Error.RateLimit("API rate limit exceeded. Please try again in 60 seconds")
Error.RateLimit("Daily quota of 1000 requests exceeded", userId)
Error.RateLimit("Too many login attempts. Account temporarily locked")

Remarks

Include retry-after information in the detail message when appropriate. Consider adding custom properties for RetryAfter seconds if needed for your API design.

Constructors

RateLimitError(string, string, string?)

Initializes a new instance of the RateLimitError class.

public RateLimitError(string detail, string code, string? instance = null)

Parameters