Simplify C string to String conversion in IOError.reasonForError #544
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
Motivation: The stray space looks like an oversight. Modifications: Removed a stray space from the end of a string interpolation literal that's used to construct an error message. Result: The exact value (but not the meaning) of the error message string changes. Clients that match against the exact error message might break, but that's arguably bad practice.
Motivation: The standard library already has a String initializer that takes a null-terminated UTF-8 C string. There's no need to construct an UnsafeBufferPointer to use the Collection-based init(decoding:as:). Modifications: Replaced a manual pointer conversion with the appropriate stdlib API. Result: No change. Both version return the same String. The new version is is arguably more correct because it saves the memory-rebinding step. I haven't added new tests because the modified code is covered by SystemTest.testErrorsWorkCorrectly.
|
Can one of the admins verify this patch? |
1 similar comment
|
Can one of the admins verify this patch? |
Lukasa
approved these changes
Aug 1, 2018
|
@Lukasa Sure, no problem. 👍 |
|
@swift-nio-bot test this please |
weissi
pushed a commit
that referenced
this pull request
Aug 29, 2018
* Simplify C string to String conversion in IOError.reasonForError Motivation: The standard library already has a String initializer that takes a null-terminated UTF-8 C string. There's no need to construct an UnsafeBufferPointer to use the Collection-based init(decoding:as:). Modifications: Replaced a manual pointer conversion with the appropriate stdlib API. Result: No change. Both version return the same String. The new version is is arguably more correct because it saves the memory-rebinding step. I haven't added new tests because the modified code is covered by SystemTest.testErrorsWorkCorrectly. Motivation: Explain here the context, and why you're making that change. What is the problem you're trying to solve. Modifications: Describe the modifications you've done. Result: After your change, what will change.
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.
Motivation:
The standard library already has a String initializer that takes a
null-terminated UTF-8 C string. There's no need to construct an
UnsafeBufferPointerto use theCollection-basedinit(decoding:as:).Modifications:
Replaced a manual pointer conversion with the appropriate stdlib API.
I also removed a stray space from the end of the string interpolation literal
that's used to construct the error message. The stray space looked like an oversight.
Result:
The string API change doesn't change the result of the method. Both versions return the same
String. The new version is is arguably more correct because it saves the memory-rebinding step. I haven't added new tests because the modified code is covered bySystemTest.testErrorsWorkCorrectly.Removing the space at the end of the error message string changes the exact value (but not the meaning) of the error message string. Clients that match against the exact error message might break, but that's arguably bad practice.