Open
Conversation
There is already `as_slice()` which gives access to the underlying backing array where the elements are not in the order of writing. With automatic dereferencing, functions like `iter()` or `windows()` are automatically available for `HistoryBuf` and are returning items in an order which does not reflect the write order and will likely surprise users which did not carefully read all the documentation on for `HistoryBuf` like me.
Some method names already contain statements on ordering like `oldest_ordered()`. In this context a method returning an unordered slice should state this clearly.
HistoryBuf already uses extend in method names for ingesting multiple items at once and other heapless containers use push for methods ingesting a single item. Let's be more consistent with this naming scheme by switching from write to push here as well.
sirhcel
force-pushed
the
historybuf-api-streamlining
branch
from
dfd37f8 to
05a15b1
Compare
Contributor
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.
An addendum to #610 for streamlining the interface of
HistoryBufeven further. I'm opening this PR with two proposals for starting a discussion.