Guard.Net 2.0.0

.NET 5.0
There is a newer version of this package available.
See the version list below for details.
dotnet add package Guard.Net --version 2.0.0
NuGet\Install-Package Guard.Net -Version 2.0.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="Guard.Net" Version="2.0.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Guard.Net --version 2.0.0
#r "nuget: Guard.Net, 2.0.0"
#r directive can be used in F# Interactive, C# scripting and .NET Interactive. Copy this into the interactive tool or source code of the script to reference the package.
// Install Guard.Net as a Cake Addin
#addin nuget:?package=Guard.Net&version=2.0.0

// Install Guard.Net as a Cake Tool
#tool nuget:?package=Guard.Net&version=2.0.0

Guard.NET

A simple library that facilitates runtime checks of code and allows to define preconditions and invariants within a method.

Its main purpose is to leverage the precondition checks that appear in almost all methods, through a clean interface that accentuates intention and eliminates confusion.

Usage

public void AddUser(User user)
{
    Guard.NotNull(user, nameof(user), "optional custom error message");  // throws ArgumentNullException
	
    // OR use an explicit Exception
    
    var invalidOperationException = new InvalidOperationException("custom message");
    Guard.NotNull(user, invalidOperationException); 
    
    ...

}
public void GetUserByName(string name)
{
    Guard.NotNullOrWhitespace(name, nameof(name), "optional custom error message"); // throws ArgumentException

    // OR use an explicit Exception
    
    var invalidOperationException = new InvalidOperationException("custom message");
    Guard.NotNullOrWhitespace(userName, invalidOperationException);
    
    ...
	
}
public void GetUsers(int pageSize)
{
    Guard.NotGreaterThan(pageSize, _maxPageSize, nameof(pageSize), "optional custom error message"); // throws ArgumentOutOfRangeException

    // OR use an explicit Exception
    
    var invalidOperationException = new InvalidOperationException("custom message");
    Guard.NotGreaterThan(pageSize, _maxPageSize, invalidOperationException);
    
    ...
	
}
public void UpdateEmailAddress(int userId, string newEmailAddress)
{
    Guard.For(() => userId < 0, new ArgumentException(nameof(userId)));
    Guard.For(() => Regex.IsMatch(newEmailAddress, _emailRegexPattern), new ArgumentException(nameof(newEmailAddress)));

    ...
	
}

Installation

The Guard class can be used by installing Guard.NET nuget package available here.

Install-Package Guard.NET

The package has no external dependencies.

Product Versions
.NET net5.0 net5.0-windows net6.0 net6.0-android net6.0-ios net6.0-maccatalyst net6.0-macos net6.0-tvos net6.0-windows net7.0 net7.0-android net7.0-ios net7.0-maccatalyst net7.0-macos net7.0-tvos net7.0-windows
Compatible target framework(s)
Additional computed target framework(s)
Learn more about Target Frameworks and .NET Standard.
  • net5.0

    • No dependencies.

NuGet packages (43)

Showing the top 5 NuGet packages that depend on Guard.Net:

Package Downloads
Arcus.Observability.Telemetry.Core

Provides capability to improve telemetry with Serilog in applications

Arcus.Observability.Correlation

Provides capability to use correlation in applications

Arcus.Observability.Telemetry.Serilog.Enrichers

Provides capability to improve telemetry with Serilog in applications

Arcus.Security.Core

Contains core functionality for Arcus.Security

Arcus.Security.Providers.AzureKeyVault

Provides support for Azure Key Vault

GitHub repositories (1)

Showing the top 1 popular GitHub repositories that depend on Guard.Net:

Repository Stars
tomkerkhove/promitor
Bringing Azure Monitor metrics where you need them.
Version Downloads Last updated
3.0.0 53,868 8/26/2022
2.0.0 151,504 10/5/2021
1.2.0 589,899 8/24/2018
1.0.1 678 8/23/2018
1.0.0.2 4,026 6/25/2018
1.0.0.1 822 6/19/2018
1.0.0 799 4/10/2018

Migrated to .NET 5