CSharpFunctionalExtensions.HttpResults 0.0.1

.NET 8.0 This package targets .NET 8.0. The package is compatible with this framework or higher.
There is a newer version of this package available.
See the version list below for details. 
dotnet add package CSharpFunctionalExtensions.HttpResults --version 0.0.1
                    


                    

                
NuGet\Install-Package CSharpFunctionalExtensions.HttpResults -Version 0.0.1
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="CSharpFunctionalExtensions.HttpResults" Version="0.0.1" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
<PackageVersion Include="CSharpFunctionalExtensions.HttpResults" Version="0.0.1" />
                    


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="CSharpFunctionalExtensions.HttpResults" />
                    


                            Project file
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 CSharpFunctionalExtensions.HttpResults --version 0.0.1
                    


                    

                
#r "nuget: CSharpFunctionalExtensions.HttpResults, 0.0.1"
#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. 
#addin nuget:?package=CSharpFunctionalExtensions.HttpResults&version=0.0.1
                    


                            Install CSharpFunctionalExtensions.HttpResults as a Cake Addin
                        

                    

                
#tool nuget:?package=CSharpFunctionalExtensions.HttpResults&version=0.0.1
                    


                            Install CSharpFunctionalExtensions.HttpResults as a Cake Tool

CSharpFunctionalExtensions.HttpResults

dotnet nuget version nuget downloads GitHub license

Extensions for CSharpFunctionalExtensions to map Results to HttpResults in your MinimalApi

Installation

Available on NuGet.

dotnet add package CSharpFunctionalExtensions.HttpResults

or

PM> Install-Package CSharpFunctionalExtensions.HttpResults

Usage

This library provides you extension methods to map the following types to HttpResults:

  • Result
  • Result<T>
  • Result<T,E>
  • UnitResult<E>

These methods are available:

Method Description
.ToHttpResult()
.ToNoContentHttpResult() Discards Result value and returns empty response
.ToCreatedHttpResult()
.ToCreatedAtRouteHttpResult()
.ToAcceptedHttpResult()
.ToAcceptedAtRouteHttpResult()
.ToFileHttpResult()
.ToFileStreamHttpResult()

For almost every method you can override the default status codes for Success/Failure by passing corresponding int values.

By default, failures get mapped to a ProblemHttpResult. If you want your own mapping logic or even don't want to map to HttpErrors read on.

Custom errors

This library uses a Source Generator to generate extension methods for your own custom error types when using Result<T,E> or UnitResult<E>.

  1. First create a custom error type that implements IResultError 
    public class UserNotFoundError : IResultError
{
    public required string UserId { get; init; }
}
  2. Create a mapper that implements IResultErrorMapper which maps this custom error type to another type that you want to return in your web api: 
    public class UserNotFoundErrorMapper : IResultErrorMapper<UserNotFoundError, Microsoft.AspNetCore.Http.IResult>
{
    public Func<UserNotFoundErrorMapper, Microsoft.AspNetCore.Http.IResult> Map => error => {
        var problemDetails = new ProblemDetails
        {
            Status = 404,
            Title = "User not found",
            Type = "https://tools.ietf.org/html/rfc9110#section-15.5.5",
            Detail = $"The user with ID {error.UserId} couldn't be found.
        };

        return TypedResults.Problem(problemDetails);  
    };
}
  3. Use the generated extension method: 
    app.MapGet("/users/{id}", (string id) => {
    return userRepository.find(id) //Result<User,UserNotFoundError>
        .ToHttpResult();
});

Make sure that every IResult implementation only has exactly one corresponding IResultMapper implementation.

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

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
1.0.0 453 3/26/2025
0.9.5 455 3/26/2025
0.9.4 141 3/19/2025
0.9.3 133 3/19/2025
0.9.2 132 3/19/2025
0.9.1 160 3/12/2025
0.9.0 151 3/11/2025
0.8.0 127 2/11/2025
0.7.0 108 2/11/2025
0.6.0 101 2/8/2025
0.5.0 196 1/2/2025
0.4.0 105 1/2/2025
0.3.2 102 1/2/2025
0.3.1 96 1/2/2025
0.3.0 100 1/2/2025
0.2.0 2,024 7/18/2024
0.1.0 98 7/18/2024
0.0.5 104 7/12/2024
0.0.4 100 7/12/2024
0.0.3 95 7/12/2024
0.0.2 109 6/17/2024
0.0.1 101 6/14/2024