Tolitech.Results 1.0.0-preview.6

Tolitech.Results

Tolitech.Results is the core Results pattern library for .NET, enabling you to encapsulate operation outcomes, errors, messages, and metadata in a structured and predictable way.

Features

• Encapsulates success, failure, and error in operations.
• Rich metadata: title, detail, type, status code, messages.
• Factory methods for all major HTTP statuses and business scenarios.
• Fluent API for adding messages, titles, details, and errors.
• Support for generic results (Result<T>).

Usage Examples

Success Result

var result = Result.OK();
var resultWithValue = Result.OK<int>(42);

Error Result with Details

var result = Result.BadRequest()
    .WithTitle("Validation Error")
    .WithDetail("The 'Name' field is required.")
    .AddError("Name not provided");

Available Factory Methods

• OK(), OK<T>(T value)
• Created(), Created<T>(T value)
• Accepted(), Accepted<T>(T value)
• NoContent(), NoContent<T>()
• Found(), Found<T>(T value)
• NotModified(), NotModified<T>(T value)
• BadRequest(), BadRequest(string detail), BadRequest(string title, string detail)
• Unauthorized(), Unauthorized(string detail), Unauthorized(string title, string detail)
• Forbidden(), Forbidden(string detail), Forbidden(string title, string detail)
• NotFound(), NotFound(string detail), NotFound(string title, string detail)
• MethodNotAllowed(), MethodNotAllowed(string detail), MethodNotAllowed(string title, string detail)
• RequestTimeout(), RequestTimeout(string detail), RequestTimeout(string title, string detail)
• Conflict(), Conflict(string detail), Conflict(string title, string detail)
• TooManyRequests(), TooManyRequests(string detail), TooManyRequests(string title, string detail)
• InternalServerError(), InternalServerError(string detail), InternalServerError(string title, string detail)
• BadGateway(), BadGateway(string detail), BadGateway(string title, string detail)
• ServiceUnavailable(), ServiceUnavailable(string detail), ServiceUnavailable(string title, string detail)
• GatewayTimeout(), GatewayTimeout(string detail), GatewayTimeout(string title, string detail)

Message Handling

result.AddInformation("Processing completed successfully.");
result.AddWarning("Warning: optional field not filled.");
result.AddError("Unexpected error.", StatusCode.InternalServerError);

Important Properties

• IsSuccess, IsFailure
• StatusCode, Title, Detail, Type
• Messages (collection of messages associated with the result)

Complete Example

public class MathOperation
{
    public Result<int> Divide(int dividend, int divisor)
    {
        if (divisor == 0)
            return Result.BadRequest<int>()
                .WithTitle("Division by zero not allowed")
                .AddError("The divisor cannot be zero.");

        return Result.OK(dividend / divisor);
    }
}

For HTTP integration and fluent validations, see the Tolitech.Results.Http and Tolitech.Results.Guards projects.