Add documentation for SafeBuffer.ReadSpan/WriteSpan #54942
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
jkoritzinsky
approved these changes
Jun 30, 2021
|
At the top of the file in Line 7 the type is referenced as SafePointer, maybe change this too? |
AaronRobinsonMSFT
approved these changes
Jun 30, 2021
stephentoub
reviewed
Jun 30, 2021
| @@ -219,6 +226,11 @@ public void ReadArray<T>(ulong byteOffset, T[] array, int index, int count) | |||
| ReadSpan(byteOffset, new Span<T>(array, index, count)); | |||
| } | |||
|
|
|||
| /// <summary> | |||
| /// Reads value types from memory starting at the offset, and writes them into a span.</summary> | |||
There was a problem hiding this comment.
I think we should say something about it using the length of the span to determine how much to read.
stephentoub
approved these changes
Jun 30, 2021
ghost
locked as resolved and limited conversation to collaborators
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Add missing doc for new
SafeBuffer.ReadSpanandSafeBuffer.WriteSpan6.0 APIs.Also copied over the docs for
SafeBuffer.ReadArray/WriteArrayinto code.Contributes to #54880
cc @AaronRobinsonMSFT @jkoritzinsky