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] Fixed nullable byte arrays #20720

Open
wants to merge 3 commits into
base: master
Choose a base branch
from

Conversation

ranger-ross
Copy link
Contributor

Fixes one of the issues reported in #20500.

The issue is types with nullable string of bytes

properties:
  myByteArray:
    type: string
    format: byte
    nullable: true

will generate invalid code

struct Foo {
    #[serde_as(as = "Option<serde_with::base64::Base64>")]
    #[serde(rename = "myByteArray", default, with = "::serde_with::rust::double_option", skip_serializing_if = "Option::is_none")]
    pub my_byte_array: Option<Option<Vec<u8>>>,
}

this does not compile due to serde_as not being compatible with serde_with.

error: Cannot combine `serde_as` with serde's `with`, `deserialize_with`, or `serialize_with`.
  --> src/models/credentials.rs:22:5
   |
22 |     #[serde_as(as = "Option<serde_with::base64::Base64>")]
   |     

This PR removes the with and adds 2 Options if the type is a nullable byte array

#[serde_as(as = "Option<Option<serde_with::base64::Base64>>")]
#[serde(rename = "myByteArray", default, skip_serializing_if = "Option::is_none")]
pub my_byte_array: Option<Option<Vec<u8>>>,
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 || exit
    ./bin/generate-samples.sh ./bin/configs/*.yaml || exit
    ./bin/utils/export_docs_generators.sh || exit
    
    (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.x.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.

cc: @frol @farcaller @richardwhiuk @paladinzh @jacob-pro

@jonasbb
Copy link

jonasbb commented Feb 24, 2025

This change will deserialize a null into None. double_option converts a null into Some(None).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants