https://github.com/bjorg/argumentassert
Assert argument values and throw descriptive exceptions
https://github.com/bjorg/argumentassert
Last synced: over 1 year ago
JSON representation
Assert argument values and throw descriptive exceptions
- Host: GitHub
- URL: https://github.com/bjorg/argumentassert
- Owner: bjorg
- License: apache-2.0
- Created: 2022-02-14T23:31:01.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2023-09-23T07:12:59.000Z (almost 3 years ago)
- Last Synced: 2025-02-24T07:09:26.476Z (over 1 year ago)
- Language: C#
- Size: 15.6 KB
- Stars: 9
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: ReadMe.md
- License: LICENSE
Awesome Lists containing this project
README
# ArgumentAssert
`ArgumentAssert` is a library that simplifies asserting conditions on arguments. If the condition is not met, an `ArgumentAssertException` is thrown with a description of the failed check. In addition, the `Assert()` method informs code-analysis that the check must have been true if execution continues.
Run the `dotnet` command from your project folder to add the `ArgumentAssert` package:
```
dotnet add package ArgumentAssert
```
## Sample: Assertion throws exception
The following code asserts the `value` argument is within the expected range or throws an `ArgumentAssertException` exception.
```csharp
int AssertValueIsInRange(int value) {
ArgumentAssertException.Assert(value is > 0 and < 10);
return value;
}
```
When the assertion fails, the exception message shows the failed expression.
```
Unhandled exception. System.ArgumentAssertException: value is > 0 and < 10
```
## Sample: Assertion informs code analysis
The following code asserts the `value` argument is not null and has a length between 1 to 9 characters. Code analysis knows that the pattern is true when `Assert()` returns successfully. Therefore, there is no warning for the `return` statement.
```csharp
string AssertValueIsNotNull(string? value) {
ArgumentAssertException.Assert(value is { Length: > 0 and < 10 });
// no warning on the following line
return value.ToUpper();
}
```
When the assertion fails, the exception message shows the failed expression.
```
Unhandled exception. System.ArgumentAssertException: value is { Length: > 0 and < 10 }
```
## Sample: Streamline calls to Assert()
The following code uses the `using static` statement to expose the `Assert()` method without requiring the class name. This approach streamlines the code when many assertions are being performed throughout the codebase.
```csharp
using static System.ArgumentAssertException;
int AssertValueIsInRange(int value) {
Assert(value is > 0 and < 10);
return value;
}
```
## License
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.