Skip to content

don't expose toml::Table in public API #2037

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

Open
danieleades opened this issue Mar 1, 2023 · 0 comments
Open

don't expose toml::Table in public API #2037

danieleades opened this issue Mar 1, 2023 · 0 comments
Labels
A-API Area: API C-enhancement Category: Enhancement or feature request
Milestone

Comments

@danieleades
Copy link
Contributor

Problem

the toml::Table type is exposed in the public API (in the Config::get_preprocessor method), which means that changing the version of the toml dependency is a breaking change

Proposed Solution

hide the toml::Table value by returning a newtype, or by returning a impl Deserialize anonymous type

Notes

this change is itself a breaking change. Preprocessor developers who are accessing the Table values directly without deserialising into a custom struct will no longer be able to do so with the proposed change

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-API Area: API C-enhancement Category: Enhancement or feature request
Projects
None yet
Development

No branches or pull requests

2 participants