feat: remove unsafe fn from construction of combiners #18
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.
Motivation
IpCidrCombiner
is notunsafe
, in that contains no unsafe blocks or calls to other unsafe functions. Upholding logic requirements withunsafe
is considered a misuse.It's a shame that downstream
#[forbid(unsafe)]
crates can't use these constructors.Proposal
Remove the
unsafe
declarations for these_unchecked
functions and detail in the documentation what the logic requirements are for the arguments. (I haven't been able to figure out exactly what these requirements are from readingpush
since there's no comments explaining what's going on.)Also introduce constructors that use
push
internally for cases where the caller cannot guarantee the logic requirements.Interested on your thoughts on this.