ByteDev.Exceptions 2.3.0

dotnet add package ByteDev.Exceptions --version 2.3.0
NuGet\Install-Package ByteDev.Exceptions -Version 2.3.0
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="ByteDev.Exceptions" Version="2.3.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add ByteDev.Exceptions --version 2.3.0
#r "nuget: ByteDev.Exceptions, 2.3.0"
#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 ByteDev.Exceptions as a Cake Addin
#addin nuget:?package=ByteDev.Exceptions&version=2.3.0

// Install ByteDev.Exceptions as a Cake Tool
#tool nuget:?package=ByteDev.Exceptions&version=2.3.0

ByteDev.Exceptions

Collection of exceptions in a .NET Standard library.

Installation

ByteDev.Exceptions has been written as a .NET Standard 2.0 library, so you can consume it from a .NET Core or .NET Framework 4.6.1 (or greater) application.

ByteDev.Exceptions is hosted as a package on nuget.org. To install from the Package Manager Console in Visual Studio run:

Install-Package ByteDev.Exceptions

Further details can be found on the nuget page.

Release Notes

Releases follow semantic versioning.

Full details of the release notes can be viewed on GitHub.

Usage

The library consists of a small set of custom exceptions:

  • ApiHttpResponseException
  • ArgumentDefaultException
  • ArgumentEmptyException
  • ArgumentNullOrEmptyException
  • ArgumentNullOrWhiteSpaceException
  • DependencyNullException
  • EntityNotFoundException
  • UnexpectedEnumValueException

A number of Exception extension methods are also provided:

  • AllMessages
  • FindInner

ApiHttpResponseException

Use when a problem occurs from a HTTP based API.

For example: an unexpected response status code, unexpected response content etc.

if (httpResponse.StatusCode != HttpStatusCode.OK)
{
    string content = await httpResponse.Content.ReadAsStringAsync();

    string message = "API returned unexpected status.";

    throw new ApiHttpResponseException(message, httpResponse.StatusCode, content);
}

ArgumentDefaultException

Use when an argument value cannot be it's default value.

Often in such situations the programmer will decide to throw a ArgumentException.

Using a ArgumentDefaultException instead can give greater precision of the problem.

if (myArg == default)
{
    throw new ArgumentDefaultException(nameof(myArg));
}

ArgumentEmptyException

Use when an argument value cannot be empty.

For example in the case of an empty string or empty collection.

Often in such situations the programmer will decide to throw a ArgumentException.

Using a ArgumentEmptyException instead can give greater precision of the problem.

if (name == string.Empty)
{
    throw new ArgumentEmptyException(nameof(name));
}

ArgumentNullOrEmptyException

Use when an argument value cannot be null or empty.

Often in such situations the programmer will decide to throw a ArgumentException.

Using a ArgumentNullOrEmptyException instead can give greater precision of the problem.

if (string.IsNullOrEmpty(name))
{
    throw new ArgumentNullOrEmptyException(nameof(name));
}

ArgumentNullOrWhiteSpaceException

Use when an argument string value cannot be null or whitespace.

Often in such situations the programmer will decide to throw a ArgumentException.

Using a ArgumentNullOrWhiteSpaceException instead can give greater precision of the problem.

if (string.IsNullOrWhiteSpace(name))
{
    throw new ArgumentNullOrWhiteSpaceException(nameof(name));
}

DependencyNullException

Use when an injected dependency is null.

Classes often have dependencies that are injected at runtime through constructor, method or property injection.

A developer will often check the passed in dependency and if null throw a ArgumentNullException.

Using a DependencyNullException instead can give greater precision of the problem.

public MyService(IRepository repository)
{
    _repository = repository ?? throw new DependencyNullException(typeof(IRepository));
}

EntityNotFoundException

Use when an entity is expected to exist and does not.

For example an entity retrieved from storage or a database.

Sometimes instead of returning null from the method throwing an exception may seem more appropriate.

var customer = customerRepository.GetCustomer(id);

if (customer == null)
{
    throw new EntityNotFoundException(typeof(Customer), id);
}

UnexpectedEnumValueException

Use when an unexpected enum value is encountered.

enum LightStatus
{
    Off,
    Dimmed,
    On
}

// ...

switch (lightStatus)
{
    case LightStatus.Off:
        // do something...
        break;

    case LightStatus.Dimmed:
        // do something...
        break;

    case LightStatus.On:
        // do something...
        break;

    default:
        throw new UnexpectedEnumValueException<LightStatus>(lightStatus);
}
Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  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. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 was computed. 
.NET Framework net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
  • .NETStandard 2.0

    • No dependencies.

NuGet packages (1)

Showing the top 1 NuGet packages that depend on ByteDev.Exceptions:

Package Downloads
ByteDev.ArgValidation

.NET Standard library of helper methods to help validate arguments.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
2.3.0 427 6/17/2022
2.2.1 428 3/2/2022
2.2.0 281 11/30/2021
2.1.1 319 8/5/2021
2.1.0 458 6/3/2021
2.0.0 623 1/21/2021
1.1.0 339 1/19/2021
1.0.0 580 7/4/2020