| | | 1 | | using Enjoy.Domain.Shared.Extensions; |
| | | 2 | | |
| | | 3 | | namespace Enjoy.Domain.Shared.Errors; |
| | | 4 | | |
| | | 5 | | /// <summary> |
| | | 6 | | /// Representa un error con un código y un mensaje descriptivo. |
| | | 7 | | /// </summary> |
| | | 8 | | public readonly partial record struct Error |
| | | 9 | | { |
| | | 10 | | /// <summary> |
| | | 11 | | /// Código del error. |
| | | 12 | | /// </summary> |
| | 122 | 13 | | public string Code { get; init; } |
| | | 14 | | |
| | | 15 | | /// <summary> |
| | | 16 | | /// Mensaje descriptivo del error. |
| | | 17 | | /// </summary> |
| | 111 | 18 | | public string Message { get; init; } |
| | | 19 | | |
| | | 20 | | /// <summary> |
| | | 21 | | /// Tipo del error. |
| | | 22 | | /// </summary> |
| | 122 | 23 | | public ErrorType Type { get; init; } |
| | | 24 | | |
| | | 25 | | /// <summary> |
| | | 26 | | /// Una colección de errores adicionales que proporcionan más contexto sobre el error principal. |
| | | 27 | | /// </summary> |
| | 104 | 28 | | public IReadOnlyCollection<Error>? StackTrace { get; init; } |
| | | 29 | | |
| | | 30 | | /// <summary> |
| | | 31 | | /// Constructor por defecto que lanza una excepción. |
| | | 32 | | /// Use el método estático <see cref="Create"/> para instanciar <see cref="Error"/>. |
| | | 33 | | /// </summary> |
| | | 34 | | /// <exception cref="InvalidOperationException">Se lanza siempre para indicar que este constructor no debe ser usado |
| | | 35 | | public Error() |
| | 1 | 36 | | { |
| | 1 | 37 | | throw new InvalidOperationException("Use the static Create method to instantiate Error"); |
| | | 38 | | } |
| | | 39 | | |
| | | 40 | | /// <summary> |
| | | 41 | | /// Inicializa una nueva instancia de la estructura <see cref="Error"/> con el código, mensaje y tipo especificados. |
| | | 42 | | /// </summary> |
| | | 43 | | /// <param name="code">El código del error.</param> |
| | | 44 | | /// <param name="message">El mensaje descriptivo del error.</param> |
| | | 45 | | /// <param name="type">El tipo del error.</param> |
| | | 46 | | /// <exception cref="ArgumentNullException">Se lanza cuando el código o el mensaje son nulos.</exception> |
| | | 47 | | private Error(string? code, string? message, ErrorType type, IReadOnlyCollection<Error>? stack = null) |
| | 102 | 48 | | { |
| | 102 | 49 | | if (code is null) |
| | 1 | 50 | | { |
| | 1 | 51 | | throw new ArgumentNullException(nameof(code), "Error code cannot be null."); |
| | | 52 | | } |
| | | 53 | | |
| | 101 | 54 | | if (message is null) |
| | 1 | 55 | | { |
| | 1 | 56 | | throw new ArgumentNullException(nameof(message), "Error message cannot be null."); |
| | | 57 | | } |
| | | 58 | | |
| | 100 | 59 | | Code = !string.IsNullOrWhiteSpace(code) ? code : string.Empty; |
| | 100 | 60 | | Message = !string.IsNullOrWhiteSpace(message) ? message : string.Empty; |
| | 100 | 61 | | Type = type; |
| | 100 | 62 | | StackTrace = stack ?? []; |
| | 100 | 63 | | } |
| | | 64 | | |
| | | 65 | | /// <summary> |
| | | 66 | | /// Inicializa una nueva instancia de la estructura <see cref="Error"/> con una pila de errores. |
| | | 67 | | /// </summary> |
| | | 68 | | /// <param name="stack"></param> |
| | | 69 | | private Error(IReadOnlyCollection<Error>? stack) |
| | 3 | 70 | | { |
| | 3 | 71 | | if (stack is null || stack.IsEmptyReadOnly()) |
| | 2 | 72 | | { |
| | 2 | 73 | | throw new ArgumentNullException(nameof(stack), "Error stack cannot be null or empty."); |
| | | 74 | | } |
| | | 75 | | |
| | 1 | 76 | | Code = stack.First().Code; |
| | 1 | 77 | | Message = stack.First().Message; |
| | 1 | 78 | | Type = stack.First().Type; |
| | 1 | 79 | | StackTrace = stack; |
| | 1 | 80 | | } |
| | | 81 | | |
| | | 82 | | /// <summary> |
| | | 83 | | /// Crea una nueva instancia de la estructura <see cref="Error"/> con el código, mensaje y tipo especificados. |
| | | 84 | | /// </summary> |
| | | 85 | | /// <param name="code">El código del error.</param> |
| | | 86 | | /// <param name="message">El mensaje descriptivo del error.</param> |
| | | 87 | | /// <param name="type">El tipo del error.</param> |
| | | 88 | | /// <returns>Una nueva instancia de la estructura <see cref="Error"/>.</returns> |
| | 6 | 89 | | public static Error Create(string? code, string? message, ErrorType type, IReadOnlyCollection<Error>? stack = null) |
| | | 90 | | |
| | | 91 | | /// <summary> |
| | | 92 | | /// Crea una nueva instancia de la estructura <see cref="Error"/> con una pila de errores. |
| | | 93 | | /// </summary> |
| | | 94 | | /// <param name="error">El error existente.</param> |
| | | 95 | | /// <param name="stack">La pila de errores asociados opcional.</param> |
| | | 96 | | /// <returns>Una nueva instancia de la estructura <see cref="Error"/> con la pila de errores.</returns> |
| | 1 | 97 | | public static Error WithStack(Error error, IReadOnlyCollection<Error>? stack) => new(error.Code, error.Message, erro |
| | | 98 | | |
| | | 99 | | /// <summary> |
| | | 100 | | /// Crea una nueva instancia de la estructura <see cref="Error"/> con una pila de errores. |
| | | 101 | | /// </summary> |
| | | 102 | | /// <param name="errors">Coleccón de errores.</param> |
| | | 103 | | /// <returns>Una nueva instancia de la estructura <see cref="Error"/> con la pila de errores.</returns> |
| | 3 | 104 | | public static Error WithStack(IReadOnlyCollection<Error>? errors) => new(errors); |
| | | 105 | | |
| | | 106 | | /// <summary> |
| | | 107 | | /// Crea una nueva instancia de la estructura <see cref="Error"/> de tipo <see cref="ErrorType.Failure"/> con el cód |
| | | 108 | | /// </summary> |
| | | 109 | | /// <param name="code">El código del error.</param> |
| | | 110 | | /// <param name="message">El mensaje descriptivo del error.</param> |
| | | 111 | | /// <returns>Una nueva instancia de la estructura <see cref="Error"/>.</returns> |
| | 2 | 112 | | public static Error Failure(string? code, string? message, IReadOnlyCollection<Error>? stack = null) => new(code, me |
| | | 113 | | |
| | | 114 | | /// <summary> |
| | | 115 | | /// Crea una nueva instancia de la estructura <see cref="Error"/> de tipo <see cref="ErrorType.Unexpected"/> con el |
| | | 116 | | /// </summary> |
| | | 117 | | /// <param name="code">El código del error.</param> |
| | | 118 | | /// <param name="message">El mensaje descriptivo del error.</param> |
| | | 119 | | /// <returns>Una nueva instancia de la estructura <see cref="Error"/>.</returns> |
| | 2 | 120 | | public static Error Unexpected(string? code, string? message, IReadOnlyCollection<Error>? stack = null) => new(code, |
| | | 121 | | |
| | | 122 | | /// <summary> |
| | | 123 | | /// Crea una nueva instancia de la estructura <see cref="Error"/> de tipo <see cref="ErrorType.Validation"/> con el |
| | | 124 | | /// </summary> |
| | | 125 | | /// <param name="code">El código del error.</param> |
| | | 126 | | /// <param name="message">El mensaje descriptivo del error.</param> |
| | | 127 | | /// <returns>Una nueva instancia de la estructura <see cref="Error"/>.</returns> |
| | 77 | 128 | | public static Error Validation(string? code, string? message, IReadOnlyCollection<Error>? stack = null) => new(code, |
| | | 129 | | |
| | | 130 | | /// <summary> |
| | | 131 | | /// Crea una nueva instancia de la estructura <see cref="Error"/> de tipo <see cref="ErrorType.Conflict"/> con el có |
| | | 132 | | /// </summary> |
| | | 133 | | /// <param name="code">El código del error.</param> |
| | | 134 | | /// <param name="message">El mensaje descriptivo del error.</param> |
| | | 135 | | /// <returns>Una nueva instancia de la estructura <see cref="Error"/>.</returns> |
| | 2 | 136 | | public static Error Conflict(string? code, string? message, IReadOnlyCollection<Error>? stack = null) => new(code, m |
| | | 137 | | |
| | | 138 | | /// <summary> |
| | | 139 | | /// Crea una nueva instancia de la estructura <see cref="Error"/> de tipo <see cref="ErrorType.NotFound"/> con el có |
| | | 140 | | /// </summary> |
| | | 141 | | /// <param name="code">El código del error.</param> |
| | | 142 | | /// <param name="message">El mensaje descriptivo del error.</param> |
| | | 143 | | /// <returns>Una nueva instancia de la estructura <see cref="Error"/>.</returns> |
| | 5 | 144 | | public static Error NotFound(string? code, string? message, IReadOnlyCollection<Error>? stack = null) => new(code, m |
| | | 145 | | |
| | | 146 | | /// <summary> |
| | | 147 | | /// Crea una nueva instancia de la estructura <see cref="Error"/> de tipo <see cref="ErrorType.Unauthorized"/> con e |
| | | 148 | | /// </summary> |
| | | 149 | | /// <param name="code">El código del error.</param> |
| | | 150 | | /// <param name="message">El mensaje descriptivo del error.</param> |
| | | 151 | | /// <returns>Una nueva instancia de la estructura <see cref="Error"/>.</returns> |
| | 2 | 152 | | public static Error Unauthorized(string? code, string? message, IReadOnlyCollection<Error>? stack = null) => new(cod |
| | | 153 | | |
| | | 154 | | /// <summary> |
| | | 155 | | /// Crea una nueva instancia de la estructura <see cref="Error"/> de tipo <see cref="ErrorType.Forbidden"/> con el c |
| | | 156 | | /// </summary> |
| | | 157 | | /// <param name="code">El código del error.</param> |
| | | 158 | | /// <param name="message">El mensaje descriptivo del error.</param> |
| | | 159 | | /// <returns>Una nueva instancia de la estructura <see cref="Error"/>.</returns> |
| | 1 | 160 | | public static Error Forbidden(string? code, string? message, IReadOnlyCollection<Error>? stack = null) => new(code, |
| | | 161 | | |
| | | 162 | | /// <summary> |
| | | 163 | | /// Crea una nueva instancia de la estructura <see cref="Error"/> de tipo <see cref="ErrorType.Exception"/> con el c |
| | | 164 | | /// </summary> |
| | | 165 | | /// <param name="code">El código del error.</param> |
| | | 166 | | /// <param name="message">El mensaje descriptivo del error.</param> |
| | | 167 | | /// <returns>Una nueva instancia de la estructura <see cref="Error"/>.</returns> |
| | 4 | 168 | | public static Error Exception(string? code, string? message, IReadOnlyCollection<Error>? stack = null) => new(code, |
| | | 169 | | } |