FFD.SimpleResult 1.0.0

SimpleResult

SimpleResult is one of the simplest and fastest libraries implementing the Result Pattern.
It was designed to be straightforward and focused, including only the essential features.

Table of Contents

• Overview
• How to Use
  • Result
  • Error
• Examples
  • Returning Success or Error
  • Returning Multiple Errors
  • Documenting Errors
• Benchmarks
• License

Overview

SimpleResult provides a minimal and high-performance implementation of the Result Pattern for .NET.
It focuses on simplicity and performance while maintaining expressiveness and ease of use.

How to Use

Result

Unlike other Result Pattern libraries, SimpleResult creates a Result object only through implicit conversions.
If a successful result has no value, then you can use Result.Success() to create it.

In other words, if your function returns a Result<T>, you can simply return the value or the error(s) directly.

You also need to specify an ErrorType, which is useful when you want to classify errors (e.g., by HTTP status).

Error

Error is an immutable record struct that contains a code, a message, and a type.
It is recommended to group and define static errors to clearly document all expected errors.
See the example below.

Examples

Returning Success or Error

public Result<Order> SendOrder(Order order) 
{
    if (!order.IsPaid)
        return new Error("Order.CannotBeSent", "Order must be paid before it can be sent", ErrorType.InvalidState);
    
    order.Send();
    return order;
}

Returning Multiple Errors

Here we use the static method Error.InvalidData to create errors of type InvalidData.

public Result ValidateUser(User user) 
{
    var errors = new List<Error>();

    if (string.IsNullOrEmpty(user.Name))
        errors.Add(Error.InvalidData("User.Name", "User name cannot be null or empty"));
    if (string.IsNullOrEmpty(user.Email))
        errors.Add(Error.InvalidData("User.Email", "User email cannot be null or empty"));
    
    return errors.Any() 
        ? errors 
        : Result.Success();
}

Documenting Errors

It can be documented either as static fields or static methods.

public static class OrderErrors 
{
    public static readonly Error AlreadyExists = Error.Conflict("Order.AlreadyExists", "This order already exists");
    public static Error NotFound(Guid id) => Error.NotFound("Order.NotFound", $"The order with Id '{id}' was not found");

}

Benchmarks

Here are some benchmarks comparing the speed and memory allocation with two of the most popular Result Pattern libraries.

License

This project is licensed under the MIT License — see the LICENSE file for details.