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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add "separator" to parse nested structs #55

Open
dbofmmbt opened this issue Feb 28, 2021 · 2 comments
Open

Add "separator" to parse nested structs #55

dbofmmbt opened this issue Feb 28, 2021 · 2 comments

Comments

@dbofmmbt
Copy link

dbofmmbt commented Feb 28, 2021

馃挕 Feature description

In config-rs, there's an option to define a separator which allow users to structure their env vars. I think an example will illustrate better:

#[derive(Deserialize)]
struct Config {
    database: Database
}

#[derive(Deserialize)]
struct Database {
    name: String,
}

If we define a separator, let's say "__", we could create this Config by setting DATABASE__NAME=foo.

Would it be possible and desirable for envy to include it?

Alternatives

It is possible to get the same behavior using the flatten attribute from serde (as noticed in #15). The drawback is that it demands a good amount of boilerplate because we would have to serde's rename every field in the nested struct if we wanted to use this separator idea.

@jonasbb
Copy link

jonasbb commented Feb 28, 2021

I want to mention one alternative using serde_with::with_prefix. It's a bit less boilerplate than applying rename on every field.
It is not a replacement for having it integrated directly into envy though.

serde_with::with_prefix solution
serde_with::with_prefix!(pdatabase "database__");
#[derive(Debug, serde::Deserialize)]
struct Config {
    #[serde(flatten, with = "pdatabase")]
    database: Database,
}
#[derive(Debug, serde::Deserialize)]
struct Database {
    name: String,
}

fn main() {
    std::env::set_var("DATABASE__NAME", "foobar");
    let config: Config = envy::from_env().unwrap();
    dbg!(config);
}

@jayvdb
Copy link
Contributor

jayvdb commented Jan 23, 2024

Worth noting that flatten doesnt work with non-String datatypes. c.f. #26

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

No branches or pull requests

3 participants