Metalama.Patterns.Contracts
2024.1.30
Prefix Reserved
See the version list below for details.
dotnet add package Metalama.Patterns.Contracts --version 2024.1.30
NuGet\Install-Package Metalama.Patterns.Contracts -Version 2024.1.30
<PackageReference Include="Metalama.Patterns.Contracts" Version="2024.1.30" />
paket add Metalama.Patterns.Contracts --version 2024.1.30
#r "nuget: Metalama.Patterns.Contracts, 2024.1.30"
// Install Metalama.Patterns.Contracts as a Cake Addin #addin nuget:?package=Metalama.Patterns.Contracts&version=2024.1.30 // Install Metalama.Patterns.Contracts as a Cake Tool #tool nuget:?package=Metalama.Patterns.Contracts&version=2024.1.30
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. |
-
.NETFramework 4.7.1
- Metalama.Framework (>= 2024.1.30)
-
.NETStandard 2.0
- Metalama.Framework (>= 2024.1.30)
-
net6.0
- Metalama.Framework (>= 2024.1.30)
NuGet packages (6)
Showing the top 5 NuGet packages that depend on Metalama.Patterns.Contracts:
Package | Downloads |
---|---|
Shinya.Core
Shinya.Framework |
|
Metalama.Patterns.Caching.Aspects
A set of aspects that simplify the caching: [Cache] to cache a method result as a function of its parameters, [InvalidateCache] to invalidate the cache, or [CacheKey] to mark a cache key in a class. |
|
Atesh.Metalama
Atesh.Metalama library is a collection of custom made Metalama Aspects (a.k.a Attributes). |
|
JamesConsulting
Package Description |
|
Metalama.Patterns.Xaml
Provides custom |
GitHub repositories
This package is not used by any popular GitHub repositories.
Version | Downloads | Last updated |
---|---|---|
2025.0.7-rc | 171 | 12/6/2024 |
2025.0.6-rc | 227 | 11/15/2024 |
2025.0.5-preview | 129 | 11/8/2024 |
2025.0.4-preview | 92 | 10/31/2024 |
2025.0.3-preview | 105 | 10/25/2024 |
2025.0.2-preview | 102 | 10/24/2024 |
2025.0.1-preview | 94 | 10/14/2024 |
2024.2.31 | 133 | 12/6/2024 |
2024.2.30 | 156 | 11/15/2024 |
2024.2.29 | 211 | 10/31/2024 |
2024.2.28 | 132 | 10/25/2024 |
2024.2.27 | 114 | 10/24/2024 |
2024.2.26 | 242 | 10/14/2024 |
2024.2.25 | 180 | 10/2/2024 |
2024.2.24 | 5,124 | 9/10/2024 |
2024.2.23 | 772 | 8/30/2024 |
2024.2.22 | 193 | 8/29/2024 |
2024.2.21 | 325 | 8/28/2024 |
2024.2.20 | 1,033 | 8/15/2024 |
2024.2.19 | 794 | 8/1/2024 |
2024.2.18 | 197 | 7/29/2024 |
2024.2.17-rc | 135 | 7/22/2024 |
2024.2.16-rc | 128 | 7/18/2024 |
2024.2.15-rc | 172 | 7/12/2024 |
2024.2.14-rc | 202 | 7/8/2024 |
2024.2.13-rc | 137 | 7/2/2024 |
2024.2.12-preview | 190 | 6/28/2024 |
2024.2.11-preview | 138 | 6/26/2024 |
2024.2.10-preview | 133 | 6/20/2024 |
2024.2.9-preview | 172 | 6/11/2024 |
2024.2.8-preview | 104 | 6/6/2024 |
2024.2.7-preview | 131 | 5/30/2024 |
2024.2.6-preview | 129 | 5/25/2024 |
2024.2.5-preview | 149 | 5/6/2024 |
2024.2.4-preview | 136 | 5/4/2024 |
2024.2.3-preview | 135 | 4/30/2024 |
2024.2.2-preview | 136 | 4/23/2024 |
2024.2.1-preview | 140 | 4/11/2024 |
2024.1.30 | 106 | 10/24/2024 |
2024.1.29 | 124 | 10/11/2024 |
2024.1.28 | 153 | 9/9/2024 |
2024.1.27 | 161 | 8/28/2024 |
2024.1.26 | 316 | 8/15/2024 |
2024.1.25 | 304 | 7/22/2024 |
2024.1.24 | 1,064 | 7/12/2024 |
2024.1.23 | 199 | 6/26/2024 |
2024.1.22 | 181 | 6/15/2024 |
2024.1.21 | 153 | 6/6/2024 |
2024.1.20 | 185 | 5/30/2024 |
2024.1.19 | 175 | 5/24/2024 |
2024.1.18 | 302 | 5/6/2024 |
2024.1.17 | 138 | 5/3/2024 |
2024.1.16 | 203 | 4/30/2024 |
2024.1.15 | 162 | 4/29/2024 |
2024.1.14 | 197 | 4/23/2024 |
2024.1.13 | 151 | 4/23/2024 |
2024.1.12 | 195 | 4/17/2024 |
2024.1.11-rc | 148 | 4/11/2024 |
2024.1.10-rc | 138 | 4/4/2024 |
2024.1.9-rc | 126 | 3/27/2024 |
2024.1.8-preview | 101 | 3/25/2024 |
2024.1.7-preview | 145 | 3/19/2024 |
2024.1.6-preview | 133 | 3/6/2024 |
2024.1.5-preview | 138 | 2/29/2024 |
2024.1.4-preview | 169 | 2/27/2024 |
2024.1.3-preview | 133 | 2/23/2024 |
2024.1.2-preview | 131 | 2/7/2024 |
2024.1.1-preview | 118 | 1/30/2024 |
2024.0.16 | 189 | 6/15/2024 |
2024.0.15 | 145 | 6/6/2024 |
2024.0.14 | 150 | 5/30/2024 |
2024.0.13 | 152 | 5/24/2024 |
2024.0.12 | 178 | 4/17/2024 |
2024.0.11 | 177 | 3/21/2024 |
2024.0.10 | 143 | 3/19/2024 |
2024.0.9 | 183 | 2/29/2024 |
2024.0.8 | 174 | 2/23/2024 |
2024.0.7 | 179 | 2/7/2024 |
2024.0.6 | 229 | 1/3/2024 |
2024.0.5-rc | 193 | 12/21/2023 |
2024.0.4-rc | 157 | 12/12/2023 |
2024.0.3-preview | 175 | 12/6/2023 |
2024.0.2-preview | 178 | 11/14/2023 |
2024.0.1-preview | 145 | 11/6/2023 |
2023.4.9 | 163 | 2/7/2024 |
2023.4.8 | 199 | 12/21/2023 |
2023.4.7 | 198 | 12/12/2023 |
2023.4.6 | 237 | 11/7/2023 |
2023.4.5-rc | 162 | 10/26/2023 |
2023.4.4-preview | 162 | 10/18/2023 |
2023.4.3-preview | 167 | 10/4/2023 |
2023.4.2-preview | 173 | 9/26/2023 |
2023.3.10-preview | 159 | 12/21/2023 |
2023.3.9-preview | 155 | 12/12/2023 |
2023.3.8-preview | 159 | 10/17/2023 |
2023.3.7-preview | 159 | 9/29/2023 |
2023.3.6-preview | 154 | 9/26/2023 |
2023.3.5-preview | 200 | 9/13/2023 |
2023.3.4-preview | 214 | 8/30/2023 |