Fix some clippy warnings #34
Open
+22
−17
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
robsdedude
reviewed
Jun 24, 2025
| @@ -104,7 +104,7 @@ pub enum Neo4jError { | |||
| /// * the server returns an error. | |||
| #[error("{error}")] | |||
| #[non_exhaustive] | |||
| ServerError { error: ServerError }, | |||
| ServerError { error: Box<ServerError> }, | |||
There was a problem hiding this comment.
Since this is a user-facing (and breaking) API change, can you please add an entry to CHANGELOG.md? I suggest to classify this under "Improvements" and please also add the "
There was a problem hiding this comment.
Also, this section of CONTRIBUTING.md might be relevant as well since you're changing the public API.
neo4j/src/error_.rs
Outdated
| @@ -55,7 +55,7 @@ type BoxError = Box<dyn StdError + Send + Sync>; | |||
| /// the server version. | |||
| pub enum Neo4jError { | |||
| /// used when | |||
| /// * experiencing a connectivity error. | |||
| /// * experiencing a connectivity error. | |||
There was a problem hiding this comment.
Suggested change
| /// * experiencing a connectivity error. | |
| /// * experiencing a connectivity error. |
Please don't remove the line breaks from the markdown docs 😇 There more places like this in the PR. I spare you repeating this comment there.
|
Done. I've added a line on the CHANGELOG.md and removed all the whitespace changes. |
The servererror variant of neo4jerror is huge. on my computer it is 184 bytes. clippy warns us that it's not recommended to have an err variant that big. the solution is to box the servererror, which requires a memory allocation, but reduces the size of the result. this way, we won't need to reserve that much stack space for every result. errors are less common to occur, so the benefit of reducing the size of all results should compensate for the memory allocation required in case of a servererror. see the details of this lint on the link below: https://rust-lang.github.io/rust-clippy/master/index.html#result_large_err>
The RecordBuffer::Transaction variant is empty. Clippy suggests
removing the struct pattern `{..}`.
Instead of using the format! macro, which creates a string, feed the format directly to the trace! and debug! macros. This achieves the same result, without creating an intermediate String.
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.
Hello. When building this crate clippy emits some warnings.
One of them is about the size of the
neo4j::Resulttype.Neo4jError has a
ServerErrorvariant that takes up a lot of space. This forces all Neo4jErrors, and thusall
neo4j::Results to be huge, which can impact performance.The suggested solution is to wrap the
ServerErroron aBox. This reduces the size of aNeo4jErrorfrom 184 bytes to 40 bytes (on my computer).The other warnings were less important. Two of them were more of a style lint, the other was about an
unnecessary use of the format! macro.
P.D: This crate is amazing. I've used it for a school project, thank you!! :)