Change insert(:within:) to return whether the range set was modified
#4
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
The insert method ``` public mutating func insert<C>(_ index: Bound, within collection: C) -> Bool ``` now returns a `Bool` indicating whether the range set was modified. The other insert method, `insert(contentsOf:)`, and the modified one now call into an `internal` version: ``` internal mutating func _insert(contentsOf range: Range<Bound>) -> Bool ``` The `public` version of `insert(contentsOf:)` ignores the return value, and `insert(:within:)` returns the result. ## Motivation Some use cases need to know if the range set was modified, and would previously have to call `contains()` and then `insert()` basically doubling the work to be done — since both have to do a search in the range set. One example is building a type that conforms to `SetAlgebra` and basing it on `RangeSet`. The `insert()` method needed for `SetAlgebra` needs to know if its value has been mutated.
|
This change has been incorporated into the latest API design of the |
|
swiftlang/swift#69766, which includes this suggestion, has been merged. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 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.
The insert method
now returns a
Boolindicating whether the range set was modified.The other insert method,
insert(contentsOf:), and the modified one now call into aninternalversion:The
publicversion ofinsert(contentsOf:)ignores the return value, andinsert(:within:)returns the result.Motivation
Some use cases need to know if the range set was modified, and would previously have to call
contains()and theninsert()basically doubling the work to be done — since both have to do a search in the range set.One example is building a type that conforms to
SetAlgebraand basing it onRangeSet. Theinsert()method needed forSetAlgebraneeds to know if its value has been mutated.