MFA.Result 8.0.4

MFA.Result NuGet Package

Overview

MFA.Result is a lightweight, versatile .NET library designed to simplify error handling and response management in your applications. It provides a robust way to encapsulate the results of operations, including success or failure information along with data and error messages. This library is ideal for APIs, web applications, and any .NET project that requires clear and concise result management.

Features

• Generic Result<T> class to handle operation outcomes with success or failure states.
• Support for HTTP status codes to align with RESTful API response patterns.
• Implicit conversion operators for easy construction of Result objects.
• Optional error messages list for detailed failure information.

Installation

To install MFA.Result, use the NuGet Package Manager console:

Installation of MFA.Result can be done using several methods as described below. Choose the one that best fits your development environment and workflow.

Using NuGet Package Manager Console

To install MFA.Result via the NuGet Package Manager Console in Visual Studio, use the following command:

Install-Package MFA.Result -Version 8.0.4

Using NuGet CLI

If you prefer using the command line, NuGet CLI can be used to install MFA.Result. First, ensure you have the NuGet CLI installed, then run the following command:

nuget install MFA.Result -Version 8.0.4

Using Visual Studio's NuGet Package Manager GUI

For those who prefer a graphical interface within Visual Studio:

1. Open your solution in Visual Studio.
2. Right-click on your project in the Solution Explorer and select Manage NuGet Packages.
3. Go to the Browse tab, search for MFA.Result, select it, then press Install.
4. Choose the version you wish to install if prompted.

These methods provide flexibility in how you can add MFA.Result to your projects, depending on your preference for tooling and the environment.

Usage

Below are some examples of how to use the MFA.Result library in your projects.

Successful Operation (Implicit Conversion)

public Result<string> GetUserName(int userId)
{
    // Your logic here
    return "John Doe"; // Implicitly converts to a successful Result
}

Successful Operation (Using Succeed Method)

public Result<string> GetUserNameWithSucceed(int userId)
{
    // Instead of relying on implicit conversion, directly use the Succeed method for clarity
    return Result<string>.Succeed("John Doe");
}

Operation With Error (Implicit Conversion)

public Result<string> GetUserName(int userId)
{
    // Your logic here
    return (404, "User not found"); // StatusCode is now an integer, converts implicitly to a failure Result
}

Operation With Error (Using Failure Method with a Single Error Message)

public Result<string> GetUserNameWithFailure(int userId)
{
    // Explicitly use the Failure method for creating a failure Result with a status code and a single error message
    return Result<string>.Failure(404, "User not found");
}

Operation With Error (Using Failure Method with Multiple Error Messages)

public Result<string> GetMultipleErrors(int userId)
{
    // Use the Failure method with a status code and a list of error messages for multiple errors
    return Result<string>.Failure(404, new List<string> {"User not found", "Data incomplete"});
}

Operation With Error (Using Failure Method with a Single Error Message and Default Status Code)

public Result<string> GetDefaultStatusCodeError(int userId)
{
    // Use the Failure method with a single error message. This uses a default status code (e.g., 500)
    return Result<string>.Failure("Internal server error");
}

Operation With Error (Using Failure Method with Multiple Error Messages and Default Status Code)

public Result<string> GetDefaultStatusCodeMultipleErrors(int userId)
{
    // Use the Failure method with a list of error messages. This uses a default status code (e.g., 500)
    return Result<string>.Failure(new List<string> {"Internal server error", "Unexpected error"});
}

Checking Operation Result

var result = GetUserName(1);
if (result.IsSuccessful)
{
    Console.WriteLine(result.Data);
}
else
{
    Console.WriteLine(result.ErrorMessages.FirstOrDefault());
}

Contributing

Contributions are welcome! If you have suggestions or want to improve MFA.Result, please feel free to fork the repository, make changes, and submit a pull request.

Release Notes

Version 8.0.1

• Changed: StatusCode property type has been updated from HttpStatusCode to int.

Version 8.0.2

• Added Succeed and Failure methods for clearer result creation.

Version 8.0.3

• Expanded the Failure method into four distinct variations to provide more flexibility and clarity when handling error scenarios. This update allows for more precise error management and reporting by enabling the following:
  • Creation of failure results with a single error message and a specific status code.
  • Creation of failure results with multiple error messages and a specific status code.
  • Creation of failure results with a single error message using a default status code (500).
  • Creation of failure results with multiple error messages using a default status code (500).
• These enhancements are designed to improve the usability and expressiveness of the MFA.Result library, making it easier for developers to communicate the outcome of operations with varied error conditions.

Version 8.0.4

• Updated: Made Succeed method static for API consistency.

Upgrade to version 8.0.4 is highly recommended to enhance the functionality and clarity of your error handling patterns.

License

MFA.Result is available under the MIT license. See the LICENSE file for more info.