Repository navigation
Document when an IPC read means end-of-stream - #130
Merged
Merged
Conversation
The synchronous reads distinguish "nothing ready yet" from end-of-stream by returning nil versus empty, but said so nowhere, so a caller had no way to tell the two apart. The callback variants already deliver nil at EOF.
kasperisager
approved these changes
Sep 18, 2026
Merged
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
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.
The synchronous reads distinguish "nothing ready yet" from end-of-stream by returning
nil/null versus empty, but said so nowhere, so a caller reading the headers had no way to tell the two apart.Docs only, no behaviour change.
Worth noting for #83, whose third bullet asks for the opposite: it reads a zero-length result as a bug and wants
nilinstead. That would make end-of-stream indistinguishable from a would-block on the synchronous reads, sincenilalready means "nothing ready yet". The symptom #83 actually describes - bare-kit-swift'sIPC: AsyncSequencenever terminating - comes from the callback variants, and those were fixed in #86 and #89; they delivernil/null at EOF and this documents that too. So I do not think there is anything left to implement there, only to document, but that bullet should be re-read rather than closed on my say-so.