OperationResultCore 4.1.0-beta2

.NET 6.0 This package targets .NET 6.0. The package is compatible with this framework or higher.
This is a prerelease version of OperationResultCore.
There is a newer version of this package available.
See the version list below for details. 
dotnet add package OperationResultCore --version 4.1.0-beta2                

                    
                

            
NuGet\Install-Package OperationResultCore -Version 4.1.0-beta2
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="OperationResultCore" Version="4.1.0-beta2" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
paket add OperationResultCore --version 4.1.0-beta2                

                    
                

            
#r "nuget: OperationResultCore, 4.1.0-beta2"
#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 OperationResultCore as a Cake Addin
#addin nuget:?package=OperationResultCore&version=4.1.0-beta2&prerelease

// Install OperationResultCore as a Cake Tool
#tool nuget:?package=OperationResultCore&version=4.1.0-beta2&prerelease

OperationResult

OperationResult is an implementation of RFC7807. In other words, it's simple wrapper for result operation for any returned data from backend, where you can add additional information about problem or other things.

"Частичная реализация" стандарта RFC7807, который определяет в документе следующее:

This document defines a "problem detail" as a way to carry machine- readable details of errors in a HTTP response to avoid the need to define new error response formats for HTTP APIs.

Суть в том, что если у вас есть API и в нем есть методы отдающие данные, например Product, то в результате успешного результата вы должны отдать сам объект Product. А вот если по какой-то причине вы не можете отдать конкретный объект (или объекты), тогда вы должные указать по какой причине вы не можете это сделать. Другими словами "детализировать проблему" (problem detail). А как это сделать как раз и описывает стандарт RFC7807.

Почему "Частичная реализация"? Потому что nuget-пакет и, соответственно, потребность в нем появилась задолго до появления стандарта. Постепенно, пакет трансформируется под стандарт, но это может занять некоторое время. Если у вас нет времени ждать, пишите свою реализацию или воспользуйтесь стандартами на платформе ASP.NET Core.

Версии

v4.1.0

  • Добавлена конструкция создания экземпляра сразу с Exception, но при этому с Result = null. Для этого добавлен метод WithException().
  • Добавлено несколько unit-тестов для WithException().

v4.0.2

  • Добавлена структура Empty для того, чтобы не требовался класс для создания объекта OperationResult. Тепер можно использовать Empty для создания OperationResult<T>, если не требуется никакой конкретный класс, но при этом остальные возможности востребованы.
  • Исправлены некоторые недочеты при публикации nuget-пакета.
  • Добавлено несколько unit-тестов.

Репозиторий

GitHub

Пакеты Nuget

Nuget OperationResult

Nuget OperationResultCore

Дополнительно

Статья в блоге 1

Статья в блоге 2

Видео YouTube

Product Compatible and additional computed target framework versions.
.NET net6.0 is compatible.  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 was computed.  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.

  • net6.0

    • No dependencies.

NuGet packages (6)

Showing the top 5 NuGet packages that depend on OperationResultCore:

Package Downloads
Calabonga.UnitOfWork.Controllers

Unit of Work implementation over ASP.NET Core Controllers
Calabonga.AspNetCore.Controllers

Unit of Work implementation for EntityFramework Core. Package based over the mediatr pattern (mediatr package used). For more information please see Calabonga.UnitOfWork package. Mediator pattern impementation.
Calabonga.SpecRepositoryCore

Repository and Specification patterns implementations for EntityFrameworkCore with pagination and other sugar
Calabonga.EntityFrameworkCore

Simply Data Accesss Layer for EntityFramework with some helpfull features.
Calabonga.EntityFrameworkCore.UnitOfWork.Framework

UnitOfWork for Microservices. All microservices in the system should and can use Unit of Work pattern. This package implements this pattern.

GitHub repositories (1)

Showing the top 1 popular GitHub repositories that depend on OperationResultCore:

Repository Stars
Calabonga/Microservice-Template
Templates for microservice architecture. Nimble Microservice Framework contains two modules. The first with OpenIddict and the second without OpenIddict. Templates are built on ASP.NET Core platform with different versions Core3.1, NET6, NET7 and NET8. You can create a new project extremely fast: in Visual Studio, Rider, dotnet CLI.
Version Downloads Last updated
4.1.0 2,117 9/21/2023 4.1.0 is deprecated.
4.1.0-beta2 198 7/20/2023
4.1.0-beta1 133 7/12/2023
4.0.3 339 6/20/2023
4.0.2 450 6/11/2023
4.0.2-beta2 160 12/31/2022
4.0.2-beta1 140 12/31/2022
4.0.1 1,481 12/31/2022
4.0.0 790 8/22/2022
4.0.0-beta2 187 4/3/2022
4.0.0-beta1 170 4/2/2022
3.0.1 2,642 12/3/2021
3.0.0 4,067 1/26/2021
2.1.3 1,951 9/24/2020
2.1.2 3,036 4/6/2020
2.1.1 1,352 3/27/2020
2.1.0 578 3/24/2020
2.0.14 3,036 11/27/2019
2.0.13 558 11/13/2019
2.0.12 549 11/8/2019
2.0.11 582 10/31/2019
2.0.10 559 10/30/2019
2.0.9 543 10/30/2019
2.0.8 558 10/29/2019
2.0.7 1,400 10/22/2019
2.0.1 1,139 10/4/2019
2.0.0 536 10/2/2019
1.1.0 1,870 7/18/2019
1.0.1 2,317 11/20/2018
1.0.0 8,382 11/17/2017
1.0.0-beta1 1,018 11/16/2017

OperationResult.WithException added