ThrowHelper APIs #3346
Merged
ThrowHelper APIs #3346
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Thanks Sergio0694 for opening a Pull Request! The reviewers will test the PR and highlight if there is any conflict or changes required. If the PR is approved we will proceed to merge the pull request 🙌 |
ghost
assigned 
john-h-k
reviewed
Jun 14, 2020
8 tasks
5 tasks
This reverts commit f70ae0c. Unfortunately the attribute is actually matched by type and not just by name like the others. We should reintroduce this once either dotnet/runtime#29681 is done, or when the runtime switches to a name matching for the internal attribute, so we can just use a local copy here.
Microsoft.Toolkit.HighPerformance/Enumerables/ReadOnlySpanEnumerable{T}.cs
Outdated
Show resolved
Hide resolved
Moved to related HighPerformance PR
7 tasks
azchohfi
requested changes
Aug 13, 2020
azchohfi
approved these changes
Aug 13, 2020
michael-hawker
approved these changes
Aug 19, 2020
|
Thanks for reviewing @john-h-k! |
7 tasks
ghost
pushed a commit
that referenced
this pull request
Nov 6, 2020
<!-- 🚨 Please Do Not skip any instructions and information mentioned below as they are all required and essential to evaluate and test the PR. By fulfilling all the required information you will be able to reduce the volume of questions and most likely help merge the PR faster 🚨 --> ## Follow up for #3346 and #3455 <!-- Add the relevant issue number after the "#" mentioned above (for ex: Fixes #1234) which will automatically close the issue once the PR is merged. --> <!-- Add a brief overview here of the feature/bug & fix. --> ## PR Type What kind of change does this PR introduce? <!-- Please uncomment one or more that apply to this PR. --> <!-- - Bugfix --> - Feature <!-- - Code style update (formatting) --> <!-- - Refactoring (no functional changes, no api changes) --> <!-- - Build or CI related changes --> <!-- - Documentation content changes --> <!-- - Sample app changes --> <!-- - Other... Please describe: --> ## What is the current behavior? <!-- Please describe the current behavior that you are modifying, or link to a relevant issue. --> The `ThrowHelper` class exposes static throw-helper APIs that mirror the existing constructor for all the supported exception types. In the previous PRs though I had missed the parameterless constructors, so there were no APIs for that in the `ThrowHelper` class. ## What is the new behavior? <!-- Describe how was this issue resolved or changed? --> `ThrowHelper` now exposes a parameterless overload for all the supported exception types that are exposed. ## PR Checklist Please check if your PR fulfills the following requirements: - [X] Tested code with current [supported SDKs](../readme.md#supported) - [ ] ~~Pull Request has been submitted to the documentation repository [instructions](..\contributing.md#docs). Link: <!-- docs PR link -->~~ - [ ] ~~Sample in sample app has been added / updated (for bug fixes / features)~~ - [ ] ~~Icon has been created (if new sample) following the [Thumbnail Style Guide and templates](https://github.com/windows-toolkit/WindowsCommunityToolkit-design-assets)~~ - [X] Tests for the changes have been added (for bug fixes / features) (if applicable) - [X] Header has been added to all new source files (run *build/UpdateHeaders.bat*) - [X] Contains **NO** breaking changes
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Feature: new
ThrowHelperAPIsPR Type
What kind of change does this PR introduce?
What is the current behavior?
The
Microsoft.Toolkit.Diagnosticsnamespace exposes noThrowHelperAPIs. These are useful in situations where the user can't just invoke one of theGuardAPIs to perform a check, but it might still be better to have a high performance API to delegate the exception throw operation to.This is because the throw helper pattern allows the JIT compiler to see the exception in the faulting branch, and assume that branch is always not taken. This results in better codegen both because of this, and because the actual code to instantiate the exception object is done in a method that never inlined.
What is the new behavior?
The
ThrowHelperclass is now public, with a series of throw helper APIs.All the
Guard-specific helpers are still just internal.This PR introduce helper methods to throw the following exception types:
ArrayTypeMismatchExceptionArgumentExceptionArgumentNullExceptionArgumentOutOfRangeExceptionExternalExceptionFormatExceptionInsufficientMemoryExceptionInvalidDataExceptionInvalidOperationExceptionLockRecursionExceptionMissingFieldExceptionMissingMemberExceptionMissingMethodExceptionNotSupportedExceptionObjectDisposedExceptionOperationCanceledExceptionPlatformNotSupportedExceptionSynchronizationLockExceptionTimeoutExceptionUnauthorizedAccessExceptionWin32ExceptionPR Checklist
Please check if your PR fulfills the following requirements:
Sample in sample app has been added / updated (for bug fixes / features)Icon has been created (if new sample) following the Thumbnail Style Guide and templates