feat: publicly export UniqueIter
#87
Merged
Conversation
This file contains 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
This type is returned by a public method, but it isn't publicly re-exported. This means that it cannot currently be named in downstream code, and the documentation for its `Iterator` implementation is not rendered in RustDoc. This is an oversight on my part, as the type was intended to be public. This commit fixes that, by publicly re-exporting `UniqueIter`. In addition, I've added some improved documentation for `UniqueIter`, which should help users to understand its guarantees. Fixes #77
jplatte
reviewed
Sep 27, 2023
There was a problem hiding this comment.
Yeah, this would have helped me when reading the docs :)
Not sure if it will produce some false-positives¹ for you, but the unreachable_pub lint would have caught that this type with pub visibility is not nameable by crate users.
¹ I don't personally like that it triggers on pub fields on pub(crate) types
| @@ -735,6 +738,10 @@ impl<T, C: cfg::Config> Slab<T, C> { | |||
| } | |||
|
|
|||
| /// Returns an iterator over all the items in the slab. | |||
| /// | |||
| /// Because this iterator exclusively borrows the slab (i.e. it holds an | |||
| /// `&mut Slab<T>`), elements will not be added or removed while the | |||
There was a problem hiding this comment.
Suggested change
| /// `&mut Slab<T>`), elements will not be added or removed while the | |
| /// `&mut Slab<T>`), elements can not be added or removed while the |
hawkw
added a commit
that referenced
this pull request
Sep 27, 2023
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.
This type is returned by a public method, but it isn't publicly re-exported. This means that it cannot currently be named in downstream code, and the documentation for its
Iteratorimplementation is not rendered in RustDoc. This is an oversight on my part, as the type was intended to be public.This commit fixes that, by publicly re-exporting
UniqueIter. In addition, I've added some improved documentation forUniqueIter, which should help users to understand its guarantees.Fixes #77