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

Added gated serde support for metadata behind serde feature flag #251

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

Conversation

dustins
Copy link

@dustins dustins commented Jan 14, 2024

I had a use case for needing to (de)serialize the metadata tags. It was a relatively simple code change to add support since there aren't any exotic types being used and any overhead can be hidden behind a feature flag.

I'm relatively new and unfamiliar with much of the project so if there are other obvious parts of core that could benefit please let me know and I could add them.

@abique
Copy link
Contributor

abique commented Feb 5, 2024

If you add serde to the tags, it implies that the library also guarantee the tags stability, so a tag that you serialize today, you'll be able to de-serialize it in 10 years.

It isn't a light decision.

@dustins
Copy link
Author

dustins commented Feb 6, 2024

Thanks for the input! I appreciate your concern but I'm not sure I agree that providing serialization capabilities infers any additional stability. As a library consumer I wouldn't expect any stronger guarantees than what the library API would provide based on versioning scheme. But maybe that is a faulty assumption on my part 🙂

@abique
Copy link
Contributor

abique commented Feb 6, 2024

At least it should be clarified in the documentation.

@dustins
Copy link
Author

dustins commented Feb 6, 2024

I'll make that change to reflect the expectations of stability. Ultimately it'll be up to the project to decide which of our assumptions they align more closely with but being more explicit about stability guarantees is an excellent suggestion!

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.

None yet

2 participants