Metalama.Patterns.Contracts
2024.1.20
Prefix Reserved
.NET 6.0
This package targets .NET 6.0. The package is compatible with this framework or higher.
.NET Standard 2.0
This package targets .NET Standard 2.0. The package is compatible with this framework or higher.
.NET Framework 4.7.1
This package targets .NET Framework 4.7.1. The package is compatible with this framework or higher.
There is a newer prerelease version of this package available.
See the version list below for details.
See the version list below for details.
dotnet add package Metalama.Patterns.Contracts --version 2024.1.20
NuGet\Install-Package Metalama.Patterns.Contracts -Version 2024.1.20
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="Metalama.Patterns.Contracts" Version="2024.1.20" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Metalama.Patterns.Contracts --version 2024.1.20
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: Metalama.Patterns.Contracts, 2024.1.20"
#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 Metalama.Patterns.Contracts as a Cake Addin
#addin nuget:?package=Metalama.Patterns.Contracts&version=2024.1.20
// Install Metalama.Patterns.Contracts as a Cake Tool
#tool nuget:?package=Metalama.Patterns.Contracts&version=2024.1.20
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
About
The Metalama.Patterns.Contracts
package implements the concept of contract-based programming, encompassing preconditions, postconditions, and invariants.
Key Features
- Implementation of preconditions and postconditions through a wide range of numeric or string-based contracts.
- Verification of invariants.
Main Types
Below is a list of available contract attributes for your selection:
Nullability Contracts
[NotNull]
verifies that the assigned value is notnull
.[Required]
contract verifies that the value is notnull
and requires the string to be non-empty.
String Contracts
[NotEmpty]
requires the string to be non-empty. Note that this contract does not validate the string against being null. If you want to prohibit both null and empty strings, use[Required]
.[CreditCard]
validates that the string is a valid credit card number.[Email]
,[Phone]
, and[Url]
validate strings against well-known regular expressions.[Regex]
validates a string against a custom regular expression.[StringLength]
validates that the length of a string falls within a specified range.
Enum Contracts
[EnumDataType]
contract can validate values of typestring
,object
, or of any integer type. It throws an exception if the value is not valid for the givenenum
type.
Numeric Contracts
The following contracts can be used to verify that a value falls within a specified range:
[LessThan]
verifies that the value is less than or equal to the specified maximum.[GreaterThan]
verifies that the value is greater than or equal to the specified minimum.[Negative]
verifies that the value is less than or equal to zero.[Positive]
verifies that the value is greater than or equal to zero.[Range]
verifies that the value is greater than or equal to a specified minimum and less than or equal to a specified maximum.[StrictlyLessThan]
verifies that the value is strictly less than the specified maximum.[StrictlyGreaterThan]
verifies that the value is strictly greater than the specified minimum.[StrictlyNegative]
verifies that the value is strictly less than zero.[StrictlyPositive]
verifies that the value is strictly greater than zero.[StrictRange]
verifies that the value is strictly greater than a specified minimum and strictly less than a specified maximum.
Collections Contracts
[NotEmpty]
contract can be used on any collection, including arrays or immutable arrays. It requires the collection or the array to contain at least one element.
Invariants
[Invariant]
causes the target method (a parameterlessvoid
method) to be invoked after each public method or property setter.[DoNotCheckInvariants]
exempts the target method from enforcing invariants, but does not exempt any method or property setter used by this method.[SuspendInvariant]
exempts the target method from enforcing invariants, including any method or property setter used by this method.
Additional Documentation
- Conceptual documentation:
- Preconditions and postconditions: https://doc.postsharp.net/metalama/patterns/contracts/adding-contracts
- Invariants: https://doc.postsharp.net/metalama/patterns/contracts/invariants
- API documentation: https://doc.postsharp.net/metalama/api/metalama-patterns-contracts
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net5.0 was computed. net5.0-windows was computed. 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. |
.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 is compatible. 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.
-
.NETFramework 4.7.1
- Metalama.Framework (>= 2024.1.20)
-
.NETStandard 2.0
- Metalama.Framework (>= 2024.1.20)
-
net6.0
- Metalama.Framework (>= 2024.1.20)
NuGet packages (3)
Showing the top 3 NuGet packages that depend on Metalama.Patterns.Contracts:
Package | Downloads |
---|---|
JamesConsulting
Package Description |
|
Metalama.Patterns.Caching.Aspects
Package Description |
|
Metalama.Patterns.Xaml
Package Description |
GitHub repositories
This package is not used by any popular GitHub repositories.
Version | Downloads | Last updated |
---|---|---|
2024.2.7-preview | 0 | 5/30/2024 |
2024.2.6-preview | 78 | 5/25/2024 |
2024.2.5-preview | 106 | 5/6/2024 |
2024.2.4-preview | 97 | 5/4/2024 |
2024.2.3-preview | 96 | 4/30/2024 |
2024.2.2-preview | 96 | 4/23/2024 |
2024.2.1-preview | 73 | 4/11/2024 |
2024.1.20 | 0 | 5/30/2024 |
2024.1.19 | 106 | 5/24/2024 |
2024.1.18 | 211 | 5/6/2024 |
2024.1.17 | 91 | 5/3/2024 |
2024.1.16 | 155 | 4/30/2024 |
2024.1.15 | 114 | 4/29/2024 |
2024.1.14 | 141 | 4/23/2024 |
2024.1.13 | 109 | 4/23/2024 |
2024.1.12 | 139 | 4/17/2024 |
2024.1.11-rc | 99 | 4/11/2024 |
2024.1.10-rc | 89 | 4/4/2024 |
2024.1.9-rc | 89 | 3/27/2024 |
2024.1.8-preview | 73 | 3/25/2024 |
2024.1.7-preview | 103 | 3/19/2024 |
2024.1.6-preview | 88 | 3/6/2024 |
2024.1.5-preview | 89 | 2/29/2024 |
2024.1.4-preview | 112 | 2/27/2024 |
2024.1.3-preview | 96 | 2/23/2024 |
2024.1.2-preview | 89 | 2/7/2024 |
2024.1.1-preview | 71 | 1/30/2024 |
2024.0.14 | 0 | 5/30/2024 |
2024.0.13 | 99 | 5/24/2024 |
2024.0.12 | 129 | 4/17/2024 |
2024.0.11 | 134 | 3/21/2024 |
2024.0.10 | 101 | 3/19/2024 |
2024.0.9 | 140 | 2/29/2024 |
2024.0.8 | 129 | 2/23/2024 |
2024.0.7 | 133 | 2/7/2024 |
2024.0.6 | 176 | 1/3/2024 |
2024.0.5-rc | 145 | 12/21/2023 |
2024.0.4-rc | 125 | 12/12/2023 |
2024.0.3-preview | 136 | 12/6/2023 |
2024.0.2-preview | 137 | 11/14/2023 |
2024.0.1-preview | 101 | 11/6/2023 |
2023.4.9 | 116 | 2/7/2024 |
2023.4.8 | 155 | 12/21/2023 |
2023.4.7 | 158 | 12/12/2023 |
2023.4.6 | 189 | 11/7/2023 |
2023.4.5-rc | 123 | 10/26/2023 |
2023.4.4-preview | 122 | 10/18/2023 |
2023.4.3-preview | 96 | 10/4/2023 |
2023.4.2-preview | 137 | 9/26/2023 |
2023.3.10-preview | 119 | 12/21/2023 |
2023.3.9-preview | 105 | 12/12/2023 |
2023.3.8-preview | 121 | 10/17/2023 |
2023.3.7-preview | 119 | 9/29/2023 |
2023.3.6-preview | 123 | 9/26/2023 |
2023.3.5-preview | 152 | 9/13/2023 |
2023.3.4-preview | 153 | 8/30/2023 |