Conversation
aki1770-del
added a commit
to aki1770-del/embedded-hal
that referenced
this pull request
Apr 11, 2026
…dded#719) The previous documentation used permissive language ("encouraged", "implementations should document") that left callers uncertain about what happens to data in flight when a future is dropped mid-transfer. Replace the vague encouragement with normative documentation that: - States explicitly the method is NOT cancel-safe by default - Describes the concrete failure mode: bytes already received from hardware FIFO/DMA may be silently discarded with no error returned - Uses SHOULD/MUST language consistent with the rest of the trait docs - Mentions the CancelSafeRead marker trait path for future opt-in - Gives callers actionable guidance (run future to completion) This follows the pattern established by Tokio's cancel-safety documentation and PR rust-embedded#469 ("io: expand docs"), closing the gap that issue rust-embedded#719 identified. Fixes rust-embedded#719 Signed-off-by: aki1770-del <aki1770@gmail.com>
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
2 participants
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.
depends on #466
std::iodocs".std::iostd::iomight be blocking or nonblocking,embedded-iois always blocking.