Pitasoft.Error 5.1.1

Pitasoft.Error

Pitasoft.Error is a class library designed to facilitate the handling and management of error collections in .NET applications. It allows grouping errors by property, handling change notifications, and serializing/deserializing error collections to/from JSON.

English | Español

English

Key Features

• ErrorCollection: A robust collection for storing errors associated with property names.
• High Performance: Optimized for low memory allocation and fast execution, especially in filtering and mass clearing operations.
• INotifyDataErrorInfo Support: Fully implements INotifyDataErrorInfo for seamless integration with WPF, MAUI, and other data-binding frameworks.
• Notifications: Support for events when the error collection changes.
• JSON Serialization: Built-in extensions to convert error collections to JSON and vice versa.
• Multi-target Support: Compatible with .NET 8.0, .NET 9.0, and .NET 10.0.

Installation

You can install this package via NuGet:

dotnet add package Pitasoft.Error

Basic Usage

Creating an Error Collection and Adding/Clearing Errors

using Pitasoft.Error;

var errors = new ErrorCollection();
errors.Add("Name", "The name is required.");
errors.Add("Email", "The email format is invalid.");

if (errors.AnyError())
{
    // Handle errors
}

// Clear errors for a specific property
errors.Clear("Name");

// Clear all errors
errors.ClearAll();

Note: The Remove and RemoveAll methods are now deprecated in favor of Clear and ClearAll to maintain naming consistency with standard .NET collections.

Using Static Creation Methods

var errors = ErrorCollection.Create("General", "An unexpected error has occurred.");

JSON Serialization

using Pitasoft.Error.Extensions;

string json = errors.ToJson();

Deserialization from JSON

string json = "{\"name\":[\"Error 1\"]}";
var errors = json.ToErrorCollection();

Event Notifications

You can subscribe to changes in the error collection:

var errors = new ErrorCollection();
errors.ErrorsChanged += (sender, e) => 
{
    Console.WriteLine($"Property '{e.PropertyName}' was updated. Action: {e.Action}");
};

errors.Add("Username", "Already exists.");

Exception Handling

Easily convert exceptions into error collections:

try 
{
    // Some code that throws
}
catch (Exception ex)
{
    var errors = ErrorCollection.Create(ex, deep: true);
    // All inner exceptions are now captured in the collection
}

License

This project is licensed under the terms specified in the License.txt file.

Benchmarks

The project is highly optimized for performance. Below is a comparison of typical operations between .NET 8.0 and .NET 10.0:

The new version of .NET 10.0 shows a significant improvement in both execution time and memory allocation efficiency for several operations.

Author

Sebastián Martínez Pérez - Pitasoft, S.L.

Español

Pitasoft.Error es una biblioteca de clases diseñada para facilitar el manejo y la gestión de colecciones de errores en aplicaciones .NET. Permite agrupar errores por propiedad, manejar notificaciones de cambios y serializar/deserializar colecciones de errores a JSON.

Características principales

• ErrorCollection: Una colección robusta para almacenar errores asociados a nombres de propiedades.
• Alto Rendimiento: Optimizada para minimizar las asignaciones de memoria y maximizar la velocidad, especialmente en operaciones de filtrado y limpieza masiva.
• Soporte INotifyDataErrorInfo: Implementa completamente INotifyDataErrorInfo para una integración fluida con WPF, MAUI y otros marcos de trabajo con enlace de datos.
• Notificaciones: Soporte para eventos cuando la colección de errores cambia.
• Serialización JSON: Extensiones integradas para convertir colecciones de errores a JSON y viceversa.
• Soporte Multi-target: Compatible con .NET 8.0, .NET 9.0 y .NET 10.0.

Instalación

Puedes instalar este paquete a través de NuGet:

dotnet add package Pitasoft.Error

Uso básico

Crear una colección de errores, añadir y limpiar errores

using Pitasoft.Error;

var errors = new ErrorCollection();
errors.Add("Nombre", "El nombre es obligatorio.");
errors.Add("Email", "El formato del email no es válido.");

if (errors.AnyError())
{
    // Manejar errores
}

// Limpiar errores de una propiedad específica
errors.Clear("Nombre");

// Limpiar todos los errores
errors.ClearAll();

Nota: Los métodos Remove y RemoveAll han sido marcados como obsoletos en favor de Clear y ClearAll para mantener la consistencia con las colecciones estándar de .NET.

Uso de métodos estáticos de creación

var errors = ErrorCollection.Create("General", "Ha ocurrido un error inesperado.");

Serialización a JSON

using Pitasoft.Error.Extensions;

string json = errors.ToJson();

Deserialización desde JSON

string json = "{\"nombre\":[\"Error 1\"]}";
var errors = json.ToErrorCollection();

Notificaciones de Eventos

Puedes suscribirte a los cambios en la colección de errores:

var errors = new ErrorCollection();
errors.ErrorsChanged += (sender, e) => 
{
    Console.WriteLine($"La propiedad '{e.PropertyName}' ha sido actualizada. Acción: {e.Action}");
};

errors.Add("Usuario", "Ya existe.");

Manejo de Excepciones

Convierte fácilmente excepciones en colecciones de errores:

try 
{
    // Código que lanza una excepción
}
catch (Exception ex)
{
    var errors = ErrorCollection.Create(ex, deep: true);
    // Todas las excepciones internas se capturan ahora en la colección
}

Licencia

Este proyecto está bajo la licencia especificada en el archivo License.txt.

Benchmarks

El proyecto está altamente optimizado. A continuación se muestra una comparativa de operaciones típicas entre .NET 8.0 y .NET 10.0:

La nueva versión de .NET 10.0 muestra una mejora significativa tanto en tiempo de ejecución como en eficiencia de asignación de memoria para varias operaciones.

Autor

Sebastián Martínez Pérez - Pitasoft, S.L.