Skip to content

Use Display instead of ToString in Rust generators - #18633

Merged
wing328 merged 1 commit into
OpenAPITools:masterfrom
dani-garcia:rust-use-display
May 12, 2024
Merged

Use Display instead of ToString in Rust generators#18633
wing328 merged 1 commit into
OpenAPITools:masterfrom
dani-garcia:rust-use-display

Conversation

@dani-garcia

Copy link
Copy Markdown
Contributor

With the latest 1.78 release of Rust, Clippy has introduced a lint warning against the direct implementation of ToString, recommending instead to implement Display: https://rust-lang.github.io/rust-clippy/master/index.html#/to_string_trait_impl

This PR changes the uses of impl ToString in the Rust generator template for impl Display. It also updates the Rust samples. Note that because Display has a blanket implementation of ToString, the resulting enums will still implement ToString, so this doesn't break anything.

Tagging openapi-generator Rust committee, like the checklist mentions: @frol @farcaller @richardwhiuk @paladinzh @jacob-pro

PR checklist

  • Read the contribution guidelines.
  • Pull Request title clearly describes the work in the pull request and Pull Request description provides details about how to validate the work. Missing information here may result in delayed response from the community.
  • Run the following to build the project and update samples:
    ./mvnw clean package 
    ./bin/generate-samples.sh ./bin/configs/*.yaml
    ./bin/utils/export_docs_generators.sh
    
    (For Windows users, please run the script in Git BASH)
    Commit all changed files.
    This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master.
    These must match the expectations made by your contribution.
    You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example ./bin/generate-samples.sh bin/configs/java*.
    IMPORTANT: Do NOT purge/delete any folders/files (e.g. tests) when regenerating the samples as manually written tests may be removed.
  • File the PR against the correct branch: master (upcoming 7.1.0 minor release - breaking changes with fallbacks), 8.0.x (breaking changes without fallbacks)
  • If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.

@wing328

wing328 commented May 10, 2024

Copy link
Copy Markdown
Member

thanks for the PR.

if no one else has further feedback on this change, I'll merge it over the weekend.

have a nice weekend.

@wing328
wing328 merged commit 9704246 into OpenAPITools:master May 12, 2024
dani-garcia added a commit to bitwarden/sdk-sm that referenced this pull request May 13, 2024
## Type of change
```
- [ ] Bug fix
- [ ] New feature development
- [x] Tech debt (refactoring, code cleanup, dependency upgrades, etc)
- [ ] Build/deploy pipeline (DevOps)
- [ ] Other
```

## Objective
Latest Rust 1.78 includes a [clippy
warning](https://rust-lang.github.io/rust-clippy/master/index.html#/to_string_trait_impl)
when implementing ToString directly instead of using Display, which
would also derive `ToString` for free. Note that there are a few uses of
`impl ToString` in the `bitwarden-api-*` packages but I haven't changed
those here. I've opened a PR in openapi-generator
OpenAPITools/openapi-generator#18633
@dani-garcia
dani-garcia deleted the rust-use-display branch May 22, 2024 10:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants