Repository navigation
README: clarify streamed reader lifetime - #315
Merged
Merged
Conversation
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.
What issue is this addressing?
None
What type of issue is this addressing?
Documentation
What this PR does | solves
The streaming note suggests retaining the original file separately in a struct to prevent garbage collection. A reachable player already retains its reader, and the MP3 decoder used in this example retains the file.
Describe the actual lifetime requirement: keep the player reachable, and avoid explicitly closing the file while it is being read. Point to PauseAndStopReading for stopping reads before closing the file.
Validation
Traced Context.NewPlayer through mux.NewPlayer's retained source, and verified go-mp3's Decoder/source retains the original reader. Checked the existing NewPlayer and PauseAndStopReading contracts. No runtime behavior or example code changes.