//
#nullable enable
using Microsoft.AspNetCore.Http;
namespace CarpaNet.AspNetCore;
///
/// ATProtocol XRPC error result implementing .
///
public sealed class ATErrorResult : IResult
{
///
/// Gets the HTTP status code.
///
public int StatusCode { get; private init; }
///
/// Gets the error type identifier.
///
public string? Error { get; private init; }
///
/// Gets the human-readable error message.
///
public string? Message { get; private init; }
///
/// Creates a Bad Request (400) error.
///
public static ATErrorResult BadRequest(string? message = null)
=> new() { StatusCode = 400, Error = "BadRequest", Message = message ?? "Bad Request" };
///
/// Creates an Unauthorized (401) error.
///
public static ATErrorResult Unauthorized(string? message = null)
=> new() { StatusCode = 401, Error = "AuthMissing", Message = message ?? "Authentication Required" };
///
/// Creates a Forbidden (403) error.
///
public static ATErrorResult Forbidden(string? message = null)
=> new() { StatusCode = 403, Error = "Forbidden", Message = message ?? "Forbidden" };
///
/// Creates a Not Found (404) error.
///
public static ATErrorResult NotFound(string? message = null)
=> new() { StatusCode = 404, Error = "NotFound", Message = message ?? "Not Found" };
///
/// Creates a Payload Too Large (413) error.
///
public static ATErrorResult PayloadTooLarge(string? message = null)
=> new() { StatusCode = 413, Error = "PayloadTooLarge", Message = message ?? "Payload Too Large" };
///
/// Creates a Too Many Requests (429) error.
///
public static ATErrorResult TooManyRequests(string? message = null)
=> new() { StatusCode = 429, Error = "TooManyRequests", Message = message ?? "Too Many Requests" };
///
/// Creates an Internal Server Error (500) error.
///
public static ATErrorResult InternalServerError(string? message = null)
=> new() { StatusCode = 500, Error = "InternalServerError", Message = message ?? "Internal Server Error" };
///
/// Creates an Internal Server Error (500) from an exception.
///
public static ATErrorResult InternalServerError(Exception exception)
=> new() { StatusCode = 500, Error = "InternalServerError", Message = exception.Message };
///
/// Creates a Not Implemented (501) error.
///
public static ATErrorResult NotImplemented(string? message = null)
=> new() { StatusCode = 501, Error = "NotImplemented", Message = message ?? "Not Implemented" };
///
/// Creates a Bad Gateway (502) error.
///
public static ATErrorResult BadGateway(string? message = null)
=> new() { StatusCode = 502, Error = "BadGateway", Message = message ?? "Bad Gateway" };
///
/// Creates a Service Unavailable (503) error.
///
public static ATErrorResult ServiceUnavailable(string? message = null)
=> new() { StatusCode = 503, Error = "ServiceUnavailable", Message = message ?? "Service Unavailable" };
///
/// Creates a Gateway Timeout (504) error.
///
public static ATErrorResult GatewayTimeout(string? message = null)
=> new() { StatusCode = 504, Error = "GatewayTimeout", Message = message ?? "Gateway Timeout" };
///
public Task ExecuteAsync(HttpContext httpContext)
{
httpContext.Response.StatusCode = StatusCode;
httpContext.Response.ContentType = "application/json";
var error = new XrpcError
{
Error = this.Error,
Message = this.Message,
};
return httpContext.Response.WriteAsync(error.ToJson());
}
}