Introduce JsonSafeString
#51
Merged
Conversation
This file contains 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
liammclennan
approved these changes
Aug 2, 2022
Merged
danbopes
reviewed
Feb 18, 2023
| /// externally validated or proven to be valid JSON before calling this constructor. | ||
| /// </summary> | ||
| /// <param name="json">A well-formed JSON string that can be included directly in a log event.</param> | ||
| public JsonSafeString(string json) |
There was a problem hiding this comment.
IMO JsonSafeString should take a string? here. Since you're already checking for null in .ToString() it should be safe to pass a null string here.
There was a problem hiding this comment.
Thanks for the note, @danbopes! In this case the intention's to communicate that the constructor is handed well-formed JSON, we're only really handling the null case in ToString() because it's impossible to prevent it in C#.
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.
Fixes #46
Since no serialization actually occurs, the PR proposes to do this without relying on the
@operator that the original ticket describes.JsonSafeStringcan be passed anywhere that property values are accepted (including throughBeginScope()).Usage
Result