Intelsoft.Platform.Common.Result 1.0.0-beta-1

Result Library

Overview

The Result and Result<T> classes are designed to represent the outcome of operations within an application. They encapsulate the success or failure of an operation, with Result<T> optionally containing a return value if the operation is successful, or errors if it fails.

This library also includes the ResultExtensions class which provides utility methods for working with Result and Result<T> objects, allowing for clean and expressive handling of operation results without the need to manually check flags and error lists.

Installation

Using NuGet Package Manager

If the library is packaged as a NuGet package, you can install it using the NuGet Package Manager with the following command:

Install-Package Intelsoft.Platform.Common.Intelsoft

Manual Installation

If you are including the library manually:

1. Clone the repository or download the latest release.
2. Include the project or compiled DLL in your solution.
3. Add a reference to the project or the DLL in your application.

Usage

Quick Start

Here is a simple example of how to use the Result and Result<T> classes:

using Intelsoft.Platform.Common.Result;

// Example of a successful result without data
Result successResult = Result.Ok();

// Example of a successful result with data
Result<int> successResultWithValue = Result.Ok(42);

// Example of a failure result
Result failureResult = Result.Fail(new Error("ERR001", "Invalid operation", ErrorType.Validation));

// Using ResultExtensions to handle results
string message = successResultWithValue.Match(
    onSuccess: value => $"Operation succeeded with value: {value}",
    onError: errors => $"Operation failed with error: {errors.First().Description}"
);

Handling Asynchronous Results

You can handle asynchronous results using the async extensions:

Task<Result<int>> resultTask = GetResultAsync();
int processedValue = await resultTask.Match(
    onSuccess: value => ProcessValue(value),
    onError: errors => HandleErrors(errors)
);

Running Tests

Ensure you have a testing framework like xUnit installed and configure your test environment:

1. Navigate to the test directory.
2. Run the tests using a test runner compatible with your setup (e.g., Visual Studio, Rider, or command line).

dotnet test

Contributing

Contributions are welcome! Please fork the repository and submit pull requests with any enhancements, bug fixes, or improvements you have made.