NTResult 1.1.0

<p align="center"> <img src="Logo.png" alt="NTResult Logo" width="128" height="128" /> </p>

NTResult Solution

NTResult is a .NET solution providing a set of libraries for handling result types, error handling, and HTTP integration in C# applications. It is designed to improve code clarity, error propagation, and integration with ASP.NET Core and Refit-based APIs.

Table of Contents

• Projects Overview
• Build Instructions
• Running Tests
• Usage Examples
  • NTResult
  • NTResult.AspNetCore.Http
  • NTResult.Refit
• License

Projects Overview

1. NTResult

• Purpose:
  • Core library for result types (Expected, Optional, etc.), error handling, and utility extensions.
  • Provides a functional approach to handling success/failure and optional values.
• Key Files:
  • Expected.cs, Optional.cs, NTResult.cs, NTFileDownload.cs
  • Extensions in Ext/
  • Custom exceptions in Exceptions/

2. NTResult.AspNetCore.Http

• Purpose:
  • Integrates NTResult types with ASP.NET Core HTTP pipeline.
  • Provides helpers for controller responses and HTTP result mapping.
• Key Files:
  • NTResultControllerBase.cs, HttpNTResult.cs
  • Extensions in Ext/

3. NTResult.Refit

• Purpose:
  • Adds support for using NTResult types with Refit (a REST library for .NET).
  • Provides extension methods for working with IApiResponse and mapping API results.
• Key Files:
  • Extensions in Ext/

4. NTResult.Tests

• Purpose:
  • Contains unit tests for all core and extension libraries.
  • Organized by subproject and feature.

Build Instructions

1. Prerequisites:

   • .NET 8.0 SDK or newer
   • (Optional) Visual Studio 2022+ or VS Code

2. Restore dependencies:

   dotnet restore NTResult.slnx
   

3. Build the solution:

   dotnet build NTResult.slnx --configuration Release
   

Running Tests

All tests are located in the NTResult.Tests project. To run all tests:

dotnet test NTResult.slnx

Usage Examples

NTResult

using NTResult;

// --- Expected usage ---
var ok = Expected.MakeExpected<int, string>(42);
if (ok.HasValue)
{
    Console.WriteLine($"Value: {ok.Value}");
}
else
{
    Console.WriteLine($"Error: {ok.Error}");
}

var err = Expected.MakeUnexpected<int, string>("Something went wrong");
if (!err.HasValue)
{
    Console.WriteLine($"Error: {err.Error}");
}

// --- Optional usage ---
var some = Optional.MakeOptional("hello");
if (some.HasValue)
{
    Console.WriteLine($"Optional value: {some.Value}");
}

var none = Optional.NullOpt<string>();
if (none.IsEmpty)
{
    Console.WriteLine("Optional is empty");
}

// --- INTResult usage ---
INTResult result = NTResult.Successful;
result
    .OnSuccess(() => Console.WriteLine("Operation succeeded!"))
    .OnFailure(ex => Console.WriteLine($"Operation failed: {ex.Message}"))
    .Finally(() => Console.WriteLine("Operation finished (success or failure)"));

// INTResult<T> usage
INTResult<string> result2 = NTResult.Success("Hello");
result2
    .OnSuccess(val => Console.WriteLine($"Success value: {val}"))
    .OnFailure(ex => Console.WriteLine($"Failed: {ex.Message}"))
    .Finally(() => Console.WriteLine("Done!"));

// --- Async usage with extension methods ---
using NTResult.Ext;
await Task.FromResult(NTResult.Successful)
    .OnSuccessAsync(() => Console.WriteLine("Async success!"));

await Task.FromResult(NTResult.Failure(new Exception("fail")))
    .OnFailureAsync(ex => Console.WriteLine($"Async failure: {ex.Message}"));

NTResult.AspNetCore.Http

using NTResult.AspNetCore.Http;
using NTResult;
using Microsoft.AspNetCore.Mvc;

// Inherit from NTResultControllerBase to use static helpers
// Return INTResult from your actions—the base class will automatically convert it to an appropriate IResult for ASP.NET Core.
public class MyController : NTResultControllerBase
{
    [HttpGet("/created")]
    public INTResult CreatedExample()
    {
        // Use the static SuccessfullyCreated property
        return SuccessfullyCreated;
    }

    [HttpGet("/forbidden")]
    public INTResult ForbiddenExample()
    {
        // Use the static FailureForbidden property
        return FailureForbidden;
    }

    [HttpGet("/conflict")]
    public INTResult ConflictExample()
    {
        // Use the static Conflict helper
        return Conflict("A conflict occurred");
    }

    [HttpGet("/custom-created")]
    public INTResult CustomCreatedExample()
    {
        // Use the static Created<T> helper for a custom value
        return Created("Resource created!");
    }
}

// Note: NTResultControllerBase will automatically convert any INTResult returned from your action
// into the correct ASP.NET Core IResult (status code, body, etc.) for the HTTP response.

NTResult.Refit

using NTResult.Refit.Ext;
using Refit;

public interface IMyApi
{
    [Get("/data")]
    Task<IApiResponse<string>> GetDataAsync();
}

// Usage in your code:
var apiResponse = await myApi.GetDataAsync();
var result = apiResponse.ToNTResult();
if (result.IsSuccess)
{
    Console.WriteLine($"API value: {result.Value}");
}
else
{
    Console.WriteLine($"API error: {result.Error.Message}");
}

License

This project is licensed under the MIT License. See LICENSE for details.