style: A rust library should not pin exact versions (use bounds instead) #90
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
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.
Currently the library does define very tight dependencies and this is not common in libraries.
Libraries should be able to use any version of the dependencies that are compatible with the code.
Think about the case of: we're depending on
serde-json==1.0.48and new versions are released (let's say1.0.53) and the new version does fix some bug or enhance performances.With the current
Cargo.tomldefinition users ofjsonschemalibrary will not have benefits of theserde-jsonimprovements and even worst they might end-up with binaries that are embedding multiple version of theserder-jsonlibrary.For this reason we should describe what are the minimum versions required for the code to compile and perform properly (maybe we depend on an higher version due to bug fixes rather than exposed features).
If this library will be used to build binary applications they will be responsible for defining the exact list of used versions (via
Cargo.lock) and if this library will be used as static library for FFI applications (ie. Python binding) then the project defining the static library will be responsible for pinning the dependencies.Some reading is on https://doc.rust-lang.org/cargo/faq.html#why-do-binaries-have-cargolock-in-version-control-but-not-libraries