OGK.EasyResult 8.0.0

dotnet add package OGK.EasyResult --version 8.0.0                
NuGet\Install-Package OGK.EasyResult -Version 8.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="OGK.EasyResult" Version="8.0.0" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add OGK.EasyResult --version 8.0.0                
#r "nuget: OGK.EasyResult, 8.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.
// Install OGK.EasyResult as a Cake Addin
#addin nuget:?package=OGK.EasyResult&version=8.0.0

// Install OGK.EasyResult as a Cake Tool
#tool nuget:?package=OGK.EasyResult&version=8.0.0                

EasyResult

EasyResult is a simple and flexible library designed to standardize the handling of results and errors in your .NET applications. It provides a straightforward way to represent success and failure outcomes with helpful status codes and messages.

Features

  • Simple Result Handling: Easily handle success and failure cases in a consistent manner.
  • Customizable Status Codes: Assign and manage status codes for different scenarios.
  • Flexible Error Messaging: Provide detailed error messages for better diagnostics.

Installation

  • **Right-click on your project in Solution Explorer and select "Manage NuGet Packages..."
  • **Search for "EasyResult" in the Browse tab.
  • **Click "Install" to add the package to your project.

Usage

Creating a Success Result

To create a result indicating a successful operation:

var successResult = Result<int>.SendSuccess(42);

Creating a Failure Result

var failureResult = Result<int>.SendFailure("An error occurred.");

Handling Results

To access the result data and status:

if (successResult.IsSuccessful)
{
    Console.WriteLine($"Success: {successResult.Data}");
}
else
{
    Console.WriteLine($"Error: {successResult.ErrorMessages}");
}

Example

Here is a complete example demonstrating how to use EasyResult:

public class Example
{
    public Result<int> Divide(int dividend, int divisor)
    {
        if (divisor == 0)
        {
            return Result<int>.SendFailure("Cannot divide by zero.");
        }

        int result = dividend / divisor;
        return Result<int>.SendSuccess(result);
    }
}

License

This project is licensed under the MIT License.

Contact

For any questions or feedback

Source Code

GitHub

Product Compatible and additional computed target framework versions.
.NET 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. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
  • 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.

Version Downloads Last updated
8.0.0 123 8/19/2024