Maleron.Results
2.0.0
.NET 8.0
This package targets .NET 8.0. The package is compatible with this framework or higher.
.NET Standard 2.0
This package targets .NET Standard 2.0. The package is compatible with this framework or higher.
dotnet add package Maleron.Results --version 2.0.0
NuGet\Install-Package Maleron.Results -Version 2.0.0
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="Maleron.Results" Version="2.0.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="Maleron.Results" Version="2.0.0" />
<PackageReference Include="Maleron.Results" />
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add Maleron.Results --version 2.0.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: Maleron.Results, 2.0.0"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
#:package Maleron.Results@2.0.0
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=Maleron.Results&version=2.0.0
#tool nuget:?package=Maleron.Results&version=2.0.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
Maleron.Results
Result Pattern and Railway Oriented Programming for .NET. Represents the outcome of an operation as a type instead of throwing exceptions.
Installation
dotnet add package Maleron.Results
Quick Start
using Maleron.Results;
// Create a success result
var ok = Result.Ok("Operation completed");
// Create a failure result
var fail = Result.Fail("Something went wrong");
// Check the outcome
if (ok.IsSuccess)
Console.WriteLine(ok.Successes[0].Message);
Generic Result
Use Result<T> to carry a value on success:
Result<User> result = Result<User>.Ok("User found", user);
if (result.IsSuccess)
{
User data = result.Data;
Console.WriteLine($"Found: {data.Name}");
}
else
{
Console.WriteLine($"Error: {result.Failures[0].Message}");
}
Creating Results
// Success with message
var ok = Result.Ok("Saved successfully");
// Failure with message
var fail = Result.Fail("Validation failed");
// Success with data
var withData = Result<User>.Ok("User found", user);
// Neutral result (for accumulation)
var result = Result.Create()
.WithSuccess(new Success("Step 1 passed"))
.WithSuccess(new Success("Step 2 passed"))
.WithFailure(new Failure("Step 3 failed"));
API
Result
| Method | Description |
|---|---|
Result.Create() |
Creates a neutral result |
Result.Ok(string message) |
Creates a success result |
Result.Fail(string message) |
Creates a failure result |
Result.Fail(Failure failure) |
Creates a failure result from a Failure object |
Result<T>
| Method | Description |
|---|---|
Result<T>.Create(T? data) |
Creates a neutral result with optional data |
Result<T>.Ok(string message, T? data) |
Creates a success result with optional data |
Result<T>.Fail(string message, T? data) |
Creates a failure result with optional data |
ResultBase (base class)
| Property | Type | Description |
|---|---|---|
IsSuccess |
bool |
True when no failures |
IsFailure |
bool |
True when any failure exists |
Reasons |
IReadOnlyList<IReason> |
All reasons (successes + failures) |
Successes |
IReadOnlyList<Success> |
Only success reasons |
Failures |
IReadOnlyList<Failure> |
Only failure reasons |
Feedback
| Product | Versions Compatible and additional computed target framework versions. |
|---|---|
| .NET | net5.0 was computed. net5.0-windows was computed. net6.0 was computed. 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 was computed. 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 was computed. 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 was computed. 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 was computed. |
| .NET Framework | net461 was computed. net462 was computed. net463 was computed. net47 was computed. net471 was computed. net472 was computed. net48 was computed. 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. |
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
-
.NETStandard 2.0
- Microsoft.Bcl.AsyncInterfaces (>= 8.0.0)
-
net8.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.