Pitasoft.Result 7.0.1

Pitasoft.Result

Pitasoft.Result is a .NET library designed to standardize responses from REST services. It provides a set of classes to wrap data, status codes, and error collections, facilitating communication between APIs and clients.

Features

• Standardized Responses: Use Result, ResultEntity<T>, and ResultEntities<T> to unify your API outputs.
• Fluent Error Handling: Easily add errors or exceptions to your results using a fluent interface.
• Status Management: Built-in StatusResult enum covering common API scenarios.
• Batch Operations: Support for batch processing results with ResultBatch<T>.
• Extensions: Helper methods to check for success, errors, or specific statuses.

Installation

dotnet add package Pitasoft.Result

Core Components

1. Simple Result

Used for operations that don't return data, only a status.

public Result DeleteUser(int id)
{
    if (id <= 0) return Result.ValidationError().AddError("id", "Invalid ID");
    // ... logic ...
    return Result.Ok();
}

2. Result with Entity

Used for operations returning a single object.

public ResultEntity<User> GetUser(int id)
{
    var user = _repository.Find(id);
    if (user == null) return ResultEntity<User>.NotExists();
    return ResultEntity<User>.Ok(user);
}

3. Result with Multiple Entities

Used for lists or paged results.

public ResultEntities<User> GetUsers(UserParameters params)
{
    var (users, total) = _repository.GetAll(params);
    return ResultEntities<User>.Ok(users, total);
}

4. Batch Result

Used for processing multiple items in a single request.

public ResultBatch<User> ImportUsers(List<User> users)
{
    var results = users.Select(u => Process(u)).ToList();
    return ResultBatch<User>.Ok(results);
}

Error Handling

The library supports a fluent API for adding errors:

return Result.ValidationError()
    .AddError("Email", "Invalid format")
    .AddError("Password", "Too short")
    .AddError(new Exception("Inner system error"));

Status Codes

The StatusResult enum includes:

• Success: Ok, Added, Updated, Deleted.
• Informational: NoExist, Warning.
• Errors: ValidationError, DataError, DatabaseError, ConcurrencyError, ConnectionError, HttpError, Error, Unauthorized, Exception.

Extensions

Import Pitasoft.Result.Extensions to use:

• result.IsSuccess(): True if status is Ok, Added, Updated, or Deleted.
• result.IsError(): True for various error statuses.
• result.IsNotExist(): True if status is NoExist.
• result.HasErrors(): True if the Errors collection is not empty.

License

Copyright © 2019-2026 Pitasoft, S.L. Licensed under the LICENSE.txt provided in this repository.