BridgingIT.DevKit.Common.Abstractions 3.0.5-preview.0.2

This is a prerelease version of BridgingIT.DevKit.Common.Abstractions.
There is a newer prerelease version of this package available.
See the version list below for details.
dotnet add package BridgingIT.DevKit.Common.Abstractions --version 3.0.5-preview.0.2
                    
NuGet\Install-Package BridgingIT.DevKit.Common.Abstractions -Version 3.0.5-preview.0.2
                    
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="BridgingIT.DevKit.Common.Abstractions" Version="3.0.5-preview.0.2" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="BridgingIT.DevKit.Common.Abstractions" Version="3.0.5-preview.0.2" />
                    
Directory.Packages.props
<PackageReference Include="BridgingIT.DevKit.Common.Abstractions" />
                    
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 BridgingIT.DevKit.Common.Abstractions --version 3.0.5-preview.0.2
                    
#r "nuget: BridgingIT.DevKit.Common.Abstractions, 3.0.5-preview.0.2"
                    
#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=BridgingIT.DevKit.Common.Abstractions&version=3.0.5-preview.0.2&prerelease
                    
Install BridgingIT.DevKit.Common.Abstractions as a Cake Addin
#tool nuget:?package=BridgingIT.DevKit.Common.Abstractions&version=3.0.5-preview.0.2&prerelease
                    
Install BridgingIT.DevKit.Common.Abstractions as a Cake Tool

bITDevKit

Empowering developers with modular components for modern application development, centered around Domain-Driven Design principles.

Our goal is to empower developers by offering modular components that can be easily integrated into your projects. Whether you're working with repositories, commands, queries, or other components, the bITDevKit provides flexible solutions that can adapt to your specific needs.

This repository includes the complete source code for the bITDevKit, along with a variety of sample applications located in the ./examples folder within the solution. These samples serve as practical demonstrations of how to leverage the capabilities of the bITDevKit in real-world scenarios. All components are available as nuget packages.

For the latest updates and release notes, please refer to the RELEASES.

Join us in advancing the world of software development with the bITDevKit!


Result.cs Overview

The Result class encapsulates the outcome of an operation, promoting an expressive and error-tolerant way to handle success and failure states.

The Result class is a central component designed to encapsulate the outcome of an operation, providing a way to represent both successful and failed operations. This class promotes a more expressive and error-tolerant approach to handling operation results, encouraging the explicit declaration of success or failure states.

Returning a Result

To return a Result from a method, you typically define the method to return Result or Result<T>, where T is the type of the value returned in case of success. Here is an example method returning a Result:

public Result PerformOperation()
{
    // Your logic here
    
    if (success)
    {
        return Result.Success();
    }
    else
    {
        return Result.Failure(new Error("Operation Failed"));
    }
}

Handling a Result

When you receive a Result from a method, you can handle it by checking its success or failure state. Here's an example:

var result = PerformOperation();

if (result.IsSuccess)
{
    // Handle success
}
else
{
    // Handle failure
    var error = result.Error;
    Console.WriteLine(error.Message);
}

Using Typed Results

Sometimes, you may want to return a result with a value. This is where Result<T> comes in handy:

public Result<int> CalculateSum(int a, int b)
{
    if (a < 0 || b < 0)
    {
        return Result.Failure<int>(new Error("Inputs must be non-negative"));
    }

    return Result.Success(a + b);
}

Handling a Result<T> involves extracting the value if the operation was successful:

var result = CalculateSum(5, 10);

if (result.IsSuccess)
{
    int sum = result.Value;
    Console.WriteLine($"Sum: {sum}");
}
else
{
    Console.WriteLine(result.Error.Message);
}

Typed Errors

Typed errors provide a more specific and structured way to handle different error scenarios. For example, the EntityNotFoundResultError class can be used to represent an error where an entity is not found:

EntityNotFoundResultError.cs:
public class EntityNotFoundResultError : Error
{
    public EntityNotFoundResultError(string entityName, object key)
        : base($"Entity '{entityName}' with key '{key}' was not found.")
    {
    }
}

You can return this typed error as follows:

public Result GetEntity(int id)
{
    var entity = repository.FindById(id);

    if (entity == null)
    {
        return Result.Failure(new EntityNotFoundResultError("EntityName", id));
    }

    return Result.Success(entity);
}

When handling the result, you can check if the error is of a specific type:

var result = GetEntity(1);

if (result.IsSuccess)
{
    // Handle success
}
else if (result.Error is EntityNotFoundResultError)
{
    var error = (EntityNotFoundResultError)result.Error;
    Console.WriteLine(error.Message);
}
else
{
    // Handle other errors
}

Other available typed errors are:

By using typed errors, you can create more expressive and manageable error handling in your application.

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.  net10.0 was computed.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (14)

Showing the top 5 NuGet packages that depend on BridgingIT.DevKit.Common.Abstractions:

Package Downloads
BridgingIT.DevKit.Common.Serialization

BridgingIT DevKit: Empowering developers with modular components for modern application development, centered around Domain-Driven Design principles. Our goal is to empower developers by offering modular components that can be easily integrated into your projects. Whether you're working with repositories, commands, queries, or other components, the bITDevKit provides flexible solutions that can adapt to your specific needs.

BridgingIT.DevKit.Common.Utilities

BridgingIT DevKit: Empowering developers with modular components for modern application development, centered around Domain-Driven Design principles. Our goal is to empower developers by offering modular components that can be easily integrated into your projects. Whether you're working with repositories, commands, queries, or other components, the bITDevKit provides flexible solutions that can adapt to your specific needs.

BridgingIT.DevKit.Domain

BridgingIT DevKit: Empowering developers with modular components for modern application development, centered around Domain-Driven Design principles. Our goal is to empower developers by offering modular components that can be easily integrated into your projects. Whether you're working with repositories, commands, queries, or other components, the bITDevKit provides flexible solutions that can adapt to your specific needs.

BridgingIT.DevKit.Application.Messaging

BridgingIT DevKit: Empowering developers with modular components for modern application development, centered around Domain-Driven Design principles. Our goal is to empower developers by offering modular components that can be easily integrated into your projects. Whether you're working with repositories, commands, queries, or other components, the bITDevKit provides flexible solutions that can adapt to your specific needs.

BridgingIT.DevKit.Application.Storage

BridgingIT DevKit: Empowering developers with modular components for modern application development, centered around Domain-Driven Design principles. Our goal is to empower developers by offering modular components that can be easily integrated into your projects. Whether you're working with repositories, commands, queries, or other components, the bITDevKit provides flexible solutions that can adapt to your specific needs.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
9.0.1-preview.0.309 31 a day ago
9.0.1-preview.0.302 108 8 days ago
9.0.1-preview.0.301 140 8 days ago
9.0.1-preview.0.300 107 8 days ago
9.0.1-preview.0.299 114 8 days ago
9.0.1-preview.0.297 109 8 days ago
9.0.1-preview.0.295 101 8 days ago
9.0.1-preview.0.294 112 8 days ago
9.0.1-preview.0.293 105 8 days ago
9.0.1-preview.0.290 114 10 days ago
9.0.1-preview.0.287 123 10 days ago
9.0.1-preview.0.286 208 14 days ago
9.0.1-preview.0.285 198 16 days ago
9.0.1-preview.0.279 192 16 days ago
9.0.1-preview.0.278 203 16 days ago
9.0.1-preview.0.277 197 16 days ago
9.0.1-preview.0.276 255 16 days ago
9.0.1-preview.0.274 112 10 days ago
9.0.1-preview.0.272 102 18 days ago
9.0.1-preview.0.271 101 18 days ago
9.0.1-preview.0.270 81 20 days ago
9.0.1-preview.0.267 108 22 days ago
9.0.1-preview.0.266 109 23 days ago
9.0.1-preview.0.265 112 23 days ago
9.0.1-preview.0.264 162 23 days ago
9.0.1-preview.0.263 108 23 days ago
9.0.1-preview.0.262 112 23 days ago
9.0.1-preview.0.261 118 23 days ago
9.0.1-preview.0.258 468 23 days ago
9.0.1-preview.0.255 80 20 days ago
9.0.1-preview.0.254 116 21 days ago
9.0.1-preview.0.253 109 21 days ago
9.0.1-preview.0.252 112 21 days ago
9.0.1-preview.0.251 109 21 days ago
9.0.1-preview.0.250 119 22 days ago
9.0.1-preview.0.247 128 22 days ago
9.0.1-preview.0.246 108 22 days ago
9.0.1-preview.0.244 145 a month ago
9.0.1-preview.0.243 219 a month ago
9.0.1-preview.0.242 151 a month ago
9.0.1-preview.0.241 148 a month ago
9.0.1-preview.0.239 149 a month ago
9.0.1-preview.0.238 246 a month ago
9.0.1-preview.0.237 204 2 months ago
9.0.1-preview.0.236 141 2 months ago
9.0.1-preview.0.235 124 2 months ago
9.0.1-preview.0.234 136 2 months ago
9.0.1-preview.0.233 156 2 months ago
9.0.1-preview.0.232 122 2 months ago
9.0.1-preview.0.231 118 2 months ago
9.0.1-preview.0.230 176 2 months ago
9.0.1-preview.0.229 135 2 months ago
9.0.1-preview.0.228 140 2 months ago
9.0.1-preview.0.227 130 2 months ago
9.0.1-preview.0.226 126 2 months ago
9.0.1-preview.0.220 160 2 months ago
9.0.1-preview.0.219 115 2 months ago
9.0.1-preview.0.218 114 2 months ago
9.0.1-preview.0.217 174 2 months ago
9.0.1-preview.0.215 138 2 months ago
9.0.1-preview.0.214 120 2 months ago
9.0.1-preview.0.213 137 2 months ago
9.0.1-preview.0.212 142 2 months ago
9.0.1-preview.0.211 117 2 months ago
9.0.1-preview.0.210 122 2 months ago
9.0.1-preview.0.209 134 2 months ago
9.0.1-preview.0.208 138 2 months ago
9.0.1-preview.0.206 123 2 months ago
9.0.1-preview.0.205 128 2 months ago
9.0.1-preview.0.204 127 2 months ago
9.0.1-preview.0.202 118 2 months ago
9.0.1-preview.0.199 58 2 months ago
9.0.1-preview.0.198 97 2 months ago
9.0.1-preview.0.196 100 2 months ago
9.0.1-preview.0.193 94 2 months ago
9.0.1-preview.0.189 121 2 months ago
9.0.1-preview.0.188 450 2 months ago
9.0.1-preview.0.187 460 2 months ago
9.0.1-preview.0.186 448 2 months ago
9.0.1-preview.0.185 448 2 months ago
9.0.1-preview.0.184 448 2 months ago
9.0.1-preview.0.183 445 2 months ago
9.0.1-preview.0.182 58 2 months ago
9.0.1-preview.0.180 108 2 months ago
9.0.1-preview.0.179 116 2 months ago
9.0.1-preview.0.178 113 2 months ago
9.0.1-preview.0.175 115 2 months ago
9.0.1-preview.0.174 115 2 months ago
9.0.1-preview.0.173 129 2 months ago
9.0.1-preview.0.172 276 2 months ago
9.0.1-preview.0.171 114 2 months ago
9.0.1-preview.0.170 114 2 months ago
9.0.1-preview.0.165 111 2 months ago
9.0.1-preview.0.162 117 2 months ago
9.0.1-preview.0.160 114 2 months ago
9.0.1-preview.0.152 96 3 months ago
9.0.1-preview.0.148 132 3 months ago
9.0.1-preview.0.147 118 3 months ago
9.0.1-preview.0.146 115 3 months ago
9.0.1-preview.0.145 123 3 months ago
9.0.1-preview.0.141 124 3 months ago
9.0.1-preview.0.140 162 3 months ago
9.0.1-preview.0.139 121 3 months ago
9.0.1-preview.0.138 133 3 months ago
9.0.1-preview.0.137 115 3 months ago
9.0.1-preview.0.135 129 3 months ago
9.0.1-preview.0.134 168 3 months ago
9.0.1-preview.0.133 164 3 months ago
9.0.1-preview.0.132 161 3 months ago
9.0.1-preview.0.130 160 3 months ago
9.0.1-preview.0.129 213 3 months ago
9.0.1-preview.0.128 165 3 months ago
9.0.1-preview.0.127 169 3 months ago
9.0.1-preview.0.125 178 3 months ago
9.0.1-preview.0.119 75 3 months ago
9.0.1-preview.0.118 58 3 months ago
9.0.1-preview.0.116 64 3 months ago
9.0.1-preview.0.112 54 3 months ago
9.0.1-preview.0.111 59 3 months ago
9.0.1-preview.0.110 111 3 months ago
9.0.1-preview.0.107 62 3 months ago
9.0.1-preview.0.106 63 3 months ago
9.0.1-preview.0.105 64 3 months ago
9.0.1-preview.0.104 69 3 months ago
9.0.1-preview.0.103 87 3 months ago
9.0.1-preview.0.102 83 3 months ago
9.0.1-preview.0.100 54 3 months ago
9.0.1-preview.0.99 95 3 months ago
9.0.1-preview.0.97 65 3 months ago
9.0.1-preview.0.96 56 3 months ago
9.0.1-preview.0.94 60 3 months ago
9.0.1-preview.0.93 85 3 months ago
9.0.1-preview.0.92 60 3 months ago
9.0.1-preview.0.91 53 3 months ago
9.0.1-preview.0.88 54 3 months ago
9.0.1-preview.0.87 240 3 months ago
9.0.1-preview.0.85 260 3 months ago
9.0.1-preview.0.84 200 3 months ago
9.0.1-preview.0.82 159 3 months ago
9.0.1-preview.0.79 169 3 months ago
9.0.1-preview.0.78 187 3 months ago
9.0.1-preview.0.77 159 3 months ago
9.0.1-preview.0.76 202 4 months ago
9.0.1-preview.0.73 193 4 months ago
9.0.1-preview.0.71 133 4 months ago
9.0.1-preview.0.70 183 4 months ago
9.0.1-preview.0.69 171 4 months ago
9.0.1-preview.0.67 182 4 months ago
9.0.1-preview.0.62 164 4 months ago
9.0.1-preview.0.58 75 4 months ago
9.0.1-preview.0.56 62 4 months ago
9.0.1-preview.0.55 52 4 months ago
9.0.1-preview.0.54 56 4 months ago
9.0.1-preview.0.53 51 4 months ago
9.0.1-preview.0.52 54 4 months ago
9.0.1-preview.0.50 69 4 months ago
9.0.1-preview.0.49 89 4 months ago
9.0.1-preview.0.47 55 4 months ago
9.0.1-preview.0.45 57 4 months ago
9.0.1-preview.0.43 62 4 months ago
9.0.1-preview.0.42 58 4 months ago
9.0.1-preview.0.41 61 4 months ago
9.0.1-preview.0.35 60 4 months ago
9.0.1-preview.0.20 57 4 months ago
9.0.1-preview.0.19 53 4 months ago
9.0.1-preview.0.18 55 4 months ago
9.0.1-preview.0.14 56 4 months ago
9.0.1-preview.0.13 62 4 months ago
9.0.1-preview.0.11 50 4 months ago
9.0.1-preview.0.10 51 4 months ago
9.0.1-preview.0.9 55 4 months ago
9.0.1-preview.0.2 110 4 months ago
3.0.5-preview.0.2 119 2 months ago
3.0.5-preview.0.1 76 4 months ago
3.0.4 477 4 months ago
3.0.4-preview.0.38 65 4 months ago
3.0.4-preview.0.37 100 6 months ago
3.0.4-preview.0.36 191 6 months ago
3.0.4-preview.0.34 65 6 months ago
3.0.4-preview.0.32 66 6 months ago
3.0.4-preview.0.31 84 6 months ago
3.0.4-preview.0.30 63 6 months ago
3.0.4-preview.0.29 54 6 months ago
3.0.4-preview.0.28 115 6 months ago
3.0.4-preview.0.27 55 6 months ago
3.0.4-preview.0.23 58 6 months ago
3.0.4-preview.0.21 50 6 months ago
3.0.4-preview.0.20 54 6 months ago
3.0.4-preview.0.19 66 6 months ago
3.0.4-preview.0.18 51 6 months ago
3.0.4-preview.0.17 54 6 months ago
3.0.4-preview.0.16 55 6 months ago
3.0.4-preview.0.15 54 6 months ago
3.0.4-preview.0.14 71 7 months ago
3.0.4-preview.0.13 64 7 months ago
3.0.4-preview.0.12 60 7 months ago
3.0.4-preview.0.8 65 7 months ago
3.0.4-preview.0.7 63 7 months ago
3.0.4-preview.0.6 55 7 months ago
3.0.4-preview.0.5 65 7 months ago
3.0.4-preview.0.4 54 7 months ago
3.0.4-preview.0.3 57 7 months ago
3.0.4-preview.0.2 61 7 months ago
3.0.4-preview.0.1 199 7 months ago
3.0.3 383 8 months ago
3.0.3-preview.0.56 72 8 months ago
3.0.3-preview.0.55 67 8 months ago
3.0.3-preview.0.54 69 8 months ago
3.0.3-preview.0.50 65 8 months ago
3.0.3-preview.0.49 81 8 months ago
3.0.3-preview.0.44 88 8 months ago
3.0.3-preview.0.43 62 8 months ago
3.0.3-preview.0.42 63 8 months ago
3.0.3-preview.0.41 66 8 months ago
3.0.3-preview.0.40 94 8 months ago
3.0.3-preview.0.39 68 8 months ago
3.0.3-preview.0.38 64 8 months ago
3.0.3-preview.0.36 68 8 months ago
3.0.3-preview.0.35 79 8 months ago
3.0.3-preview.0.34 75 8 months ago
3.0.3-preview.0.33 62 8 months ago
3.0.3-preview.0.32 92 8 months ago
3.0.3-preview.0.31 732 9 months ago
3.0.3-preview.0.30 61 9 months ago
3.0.3-preview.0.29 60 9 months ago
3.0.3-preview.0.28 50 9 months ago
3.0.3-preview.0.27 71 9 months ago
3.0.3-preview.0.26 71 9 months ago
3.0.3-preview.0.25 60 9 months ago
3.0.3-preview.0.24 71 9 months ago
3.0.3-preview.0.23 84 9 months ago
3.0.3-preview.0.22 51 10 months ago
3.0.3-preview.0.21 71 7/25/2024
3.0.3-preview.0.18 74 7/12/2024
3.0.3-preview.0.17 64 7/12/2024
3.0.3-preview.0.16 54 7/12/2024
3.0.3-preview.0.15 62 7/5/2024
3.0.3-preview.0.14 125 6/24/2024
3.0.3-preview.0.13 88 6/23/2024
3.0.3-preview.0.12 78 6/21/2024
3.0.3-preview.0.11 77 6/20/2024
3.0.3-preview.0.9 359 5/27/2024
3.0.3-preview.0.8 73 5/27/2024
3.0.3-preview.0.7 99 5/17/2024
3.0.3-preview.0.6 75 5/14/2024
3.0.3-preview.0.5 286 5/8/2024
3.0.3-preview.0.3 98 5/6/2024
3.0.3-preview.0.1 81 4/25/2024
3.0.2 1,312 4/25/2024
3.0.2-preview.0.4 94 4/25/2024
3.0.2-preview.0.3 147 4/25/2024
3.0.2-preview.0.2 98 4/25/2024
3.0.2-preview.0.1 75 4/25/2024
3.0.1 434 4/25/2024
3.0.1-preview.0.10 79 4/24/2024
3.0.1-preview.0.9 185 4/19/2024
3.0.1-preview.0.8 68 4/24/2024
3.0.1-preview.0.7 134 4/24/2024

## Release 3.0.1 [25.04.24]

- [N] Initial release

-----

- [N] New
- [M] Modified
- [B] Breaking