Remove the unsound SerializedDatabase::new function
#4110
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 commit removes the unsound `SerializedDatabase::new` function from the stable API. Semver explicitly allows breaking changes for critical bug fixes and I would classify fixing soundness bugs as critical so this should be fine to do. Practical speaking I wouldn't expect anyone to use that function anyway as the only reasonable use of `SerializedDatabase` is to be produced bye the `SqliteConnection::serialize_database_to_buffer` function. The corresponding `SqliteConnection::deserialize_readonly_database_from_buffer` function accepts a `&[u8]` buffer that can be allocated on the rust side. It looks like we just "missed" to mark this function as not-public. Fixes diesel-rs#4108
weiznich
added
the
maybe backport
3 tasks
pksunkara
approved these changes
Jul 9, 2024
weiznich
pushed a commit
to weiznich/diesel
that referenced
this pull request
Jul 16, 2024
Remove the unsound `SerializedDatabase::new` function
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 commit removes the unsound
SerializedDatabase::newfunction from the stable API. Semver explicitly allows breaking changes for critical bug fixes and I would classify fixing soundness bugs as critical so this should be fine to do.Practical speaking I wouldn't expect anyone to use that function anyway as the only reasonable use of
SerializedDatabaseis to be produced bye theSqliteConnection::serialize_database_to_bufferfunction. The correspondingSqliteConnection::deserialize_readonly_database_from_bufferfunction accepts a&[u8]buffer that can be allocated on the rust side. It looks like we just "missed" to mark this function as not-public.Fixes #4108