Easy.Tools.Result
1.0.2
dotnet add package Easy.Tools.Result --version 1.0.2
NuGet\Install-Package Easy.Tools.Result -Version 1.0.2
<PackageReference Include="Easy.Tools.Result" Version="1.0.2" />
<PackageVersion Include="Easy.Tools.Result" Version="1.0.2" />
<PackageReference Include="Easy.Tools.Result" />
paket add Easy.Tools.Result --version 1.0.2
#r "nuget: Easy.Tools.Result, 1.0.2"
#:package Easy.Tools.Result@1.0.2
#addin nuget:?package=Easy.Tools.Result&version=1.0.2
#tool nuget:?package=Easy.Tools.Result&version=1.0.2
Easy.Tools.Result
Overview
Easy.Tools.Result is a lightweight, high-performance, and enterprise-ready .NET library that implements the Result Pattern. It helps you write cleaner, more robust code by replacing exceptions with typed return values for flow control.
It supports both Imperative (if (result.IsFailure)) and Functional (result.Match(...)) programming styles.
Features
- ** Zero-Allocation:** Optimized
Success()results are cached to minimize memory pressure (GC friendly). - ** Functional Extensions:** Includes
Match,Map,Tap, andEnsurefor fluent chaining. - ** Type-Safe:** No more
nullchecks or magic strings. - ** Immutable:** Thread-safe and predictable behavior.
- ** Implicit Conversions:** Return
ErrororValuedirectly without verbose syntax. - ** Multi-Target:** Supports
.NET 10,.NET 8,.NET 6,.NET Standard 2.0/2.1, and.NET Framework 4.7.2+.
Installation
Install via NuGet Package Manager:
Install-Package Easy.Tools.Result
Or via .NET CLI:
dotnet add package Easy.Tools.Result
Usage Example
1. Defining Errors
Instead of throwing exceptions, define your domain errors statically.
public static class DomainErrors
{
public static readonly Error UserNotFound = new("User.NotFound", "The user with the specified ID was not found.");
public static readonly Error InvalidEmail = new("User.InvalidEmail", "The email format is invalid.");
}
2. Returning a Result
Refactor your services to return Result<T>. You can use Implicit Conversions for cleaner code.
public Result<User> GetUserById(int id)
{
var user = _repository.Find(id);
if (user is null)
{
// Implicitly converts Error to Result<User>
return DomainErrors.UserNotFound;
}
// Implicitly converts User to Result<User>
return user;
}
3. Handling the Result
Option A: Imperative Style (Traditional)
Use properties to control flow explicitly.
[HttpGet("{id}")]
public IActionResult GetUser(int id)
{
Result<User> result = _userService.GetUserById(id);
if (result.IsFailure)
{
return BadRequest(new { code = result.Error.Code, message = result.Error.Message });
}
return Ok(result.Value);
}
Option B: Functional Style (Fluent & Clean)
Use Match to handle success and failure in a single expression.
[HttpGet("{id}")]
public IActionResult GetUser(int id)
{
return _userService.GetUserById(id)
.Match(
onSuccess: user => Ok(user),
onFailure: error => BadRequest(new { error.Code, error.Message })
);
}
Option C: Chaining (Advanced)
Use Tap for side effects (logging) and Map for transformation.
public IActionResult GetUserDto(int id)
{
return _userService.GetUserById(id)
.Tap(user => _logger.LogInformation($"User found: {user.Name}")) // Side-effect (Logging)
.Map(user => new UserDto(user.Name, user.Email)) // Transformation
.Match(
onSuccess: dto => Ok(dto),
onFailure: error => BadRequest(error)
);
}
Advanced Features
Deconstruction
You can deconstruct the result into a tuple, similar to Go or Swift.
var (isSuccess, error) = _userService.DeleteUser(id);
if (!isSuccess)
{
Console.WriteLine($"Error: {error.Code}");
return;
}
Operator Overloading
You can compare errors directly.
if (result.Error == DomainErrors.UserNotFound)
{
// Handle specific error case
}
Why Use This Pattern?
Exceptions are for Exceptional Circumstances: A user not being found or a validation error is not an exception; it's a valid business scenario.
Performance: Throwing exceptions is expensive in .NET (stack trace generation). Returning a
Resultobject is essentially free, especially with our Zero-Allocation optimizations.Readability:
Result<User>explicitly tells the developer "This operation might fail", whereas returningUserlies (it might be null or throw).
Contributing
Contributions and suggestions are welcome. Please open an issue or submit a pull request.
License
This project is licensed under the MIT License.
2025 Elmin Alirzayev / Easy Code Tools
| Product | Versions Compatible and additional computed target framework versions. |
|---|---|
| .NET | net5.0 was computed. net5.0-windows was computed. net6.0 is compatible. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 is compatible. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 is compatible. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. net9.0 is compatible. net9.0-android was computed. net9.0-browser was computed. net9.0-ios was computed. net9.0-maccatalyst was computed. net9.0-macos was computed. net9.0-tvos was computed. net9.0-windows was computed. net10.0 is compatible. net10.0-android was computed. net10.0-browser was computed. net10.0-ios was computed. net10.0-maccatalyst was computed. net10.0-macos was computed. net10.0-tvos was computed. net10.0-windows was computed. |
| .NET Core | netcoreapp2.0 was computed. netcoreapp2.1 was computed. netcoreapp2.2 was computed. netcoreapp3.0 was computed. netcoreapp3.1 was computed. |
| .NET Standard | netstandard2.0 is compatible. netstandard2.1 is compatible. |
| .NET Framework | net461 was computed. net462 was computed. net463 was computed. net47 is compatible. net471 was computed. net472 is compatible. net48 is compatible. net481 was computed. |
| MonoAndroid | monoandroid was computed. |
| MonoMac | monomac was computed. |
| MonoTouch | monotouch was computed. |
| Tizen | tizen40 was computed. tizen60 was computed. |
| Xamarin.iOS | xamarinios was computed. |
| Xamarin.Mac | xamarinmac was computed. |
| Xamarin.TVOS | xamarintvos was computed. |
| Xamarin.WatchOS | xamarinwatchos was computed. |
-
.NETFramework 4.7
- No dependencies.
-
.NETFramework 4.7.2
- No dependencies.
-
.NETFramework 4.8
- No dependencies.
-
.NETStandard 2.0
- No dependencies.
-
.NETStandard 2.1
- No dependencies.
-
net10.0
- No dependencies.
-
net6.0
- No dependencies.
-
net7.0
- No dependencies.
-
net8.0
- No dependencies.
-
net9.0
- No dependencies.
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.
-