Shalaby.Results.ResultHelpers 1.0.2

ResultHelpers

A helper library for working with the FluentResult library in C#. It aims to provide a more convenient and expressive way to handle results, especially when dealing with asynchronous operations.

Key Features

• Full support for asynchronous operations (Async)
• Implementation of functional programming principles
• Expressive error handling
• Support for transformation and chaining operations
• Support for merging and condition checking

Functional Programming in ResultHelpers

The library implements several functional programming principles:

1. Pure Functions

• All functions in the library are pure functions
• No side effects
• Depend only on their inputs to produce outputs

2. Function Composition

await result
    .MapAsync(value => Transform(value))
    .ThenAsync(transformed => Process(transformed))
    .OnSuccess(processed => Log(processed));

3. Expressive Error Handling

await result
    .EnsureNone(value => value == null, new Error("Value cannot be null"))
    .OnFailure(errors => HandleErrors(errors));

4. Chained Asynchronous Operations

await firstTask
    .ThenAsync(firstResult => SecondOperation(firstResult))
    .ThenAsync(secondResult => ThirdOperation(secondResult));

5. Result Merging

await firstTask
    .MergeThenAsync(secondTask, (first, second) => CombineResults(first, second));

Usage Examples

Transformation and Chaining

public async Task<Result<ProcessedData>> ProcessDataAsync(InputData input)
{
    return await ValidateInput(input)
        .MapAsync(validated => TransformData(validated))
        .ThenAsync(transformed => SaveData(transformed));
}

Error Handling

public async Task<Result> HandleOperationAsync()
{
    return await PerformOperation()
        .OnFailure(errors => LogErrors(errors))
        .OnSuccess(() => LogSuccess());
}

Result Merging

public async Task<Result<CombinedResult>> CombineOperationsAsync()
{
    return await FirstOperation()
        .MergeThenAsync(SecondOperation(), (first, second) => 
            new CombinedResult(first, second));
}

API Documentation

Installation

You can install the library via NuGet:

dotnet add package ResultHelpers

Requirements

• .NET 6.0 or later
• FluentResults

Contributing

We welcome contributions! Please follow these steps:

1. Fork the project
2. Create a feature branch
3. Submit a Pull Request

License

This project is licensed under the MIT License.