Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

rust: Implement Display instead of ToString for enums #19611

Merged
merged 1 commit into from
Sep 24, 2024

Conversation

wiktor-k
Copy link
Contributor

Rust docs for ToString explicitly recommend implementing Display:

This trait is automatically implemented for any type which implements the Display trait. As such, ToString shouldn’t be implemented directly: Display should be implemented instead, and you get the ToString implementation for free.

See: https://doc.rust-lang.org/std/string/trait.ToString.html
See: Nitrokey/nethsm-sdk-rs#33

Since this is about Rust, CC'ing @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.6.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
Copy link
Member

wing328 commented Sep 23, 2024

thanks for the PR

please follow step 3 to update the samples so that CI can test the change

Rust docs for `ToString` explicitly recommend implementing `Display`:

> This trait is automatically implemented for any type which implements the Display trait. As such, ToString shouldn’t be implemented directly: Display should be implemented instead, and you get the ToString implementation for free.

See: https://doc.rust-lang.org/std/string/trait.ToString.html
See: Nitrokey/nethsm-sdk-rs#33
Signed-off-by: Wiktor Kwapisiewicz <wiktor@metacode.biz>
@wiktor-k
Copy link
Contributor Author

please follow step 3 to update the samples so that CI can test the change

Ugh, I created a commit and ran the instructions but didn't notice they change files 🤦‍♂️

I think it should be better now. Thanks for reviewing!

@wing328
Copy link
Member

wing328 commented Sep 24, 2024

@wiktor-k thanks for updating the samples

is this a breaking change?

shall we keep the ToString method for backward compatibility and mark it as deprecated?

@wiktor-k
Copy link
Contributor Author

is this a breaking change?

shall we keep the ToString method for backward compatibility and mark it as deprecated?

Hi!

No, this is not a breaking change since the Rust compiler will automatically add ToString using Display (as explained in the description from docs I quoted in the PR). (Technically it's not even possible to leave the old code as it will conflict with the auto-generated one).

This is strictly an extension of existing code. All previous code will compile without issues and it will enable new API functions.

Happy to answer further questions! 👋

@wing328
Copy link
Member

wing328 commented Sep 24, 2024

thanks for the explanation.

will merge after all tests pass

(ciricleci failure can be ignored for the time being)

@wing328 wing328 merged commit 5732e27 into OpenAPITools:master Sep 24, 2024
15 of 16 checks passed
@wiktor-k wiktor-k deleted the wiktor/implement-display branch September 24, 2024 15:11
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