Clarify the role of io.EOF in Decode #1015
Open
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.
I was originally confused by the fact that this code produced an error:
whereas this did not:
See: https://go.dev/play/p/tM_jp90fjFx
However, when I looked closer, I realized that this was the intended behavior.
Decode()
decodes the "next" document until it can't find any more, which it then indicates viaio.EOF
. If it were to returnnil
, there'd be no way for the client ofDecode()
to know there were no more documents.This change adds to the documentation so this is a bit clearer.
Closes: #805