Skip to content

Preserving casing while building configuration #564

@ohadvano

Description

@ohadvano

When reading a JSON file, for example:

{
    "myStructField": "value"
}

Using config:

let settings = Config::builder()
    .add_source(config::File::with_name("src/settings.json").required(false))
    .build()
    .unwrap();

And trying to deserialize it to a struct defined as:

#[derive(Debug, Deserialize)]
#[serde(rename_all = "cascalCase")]
pub struct MyStruct {
    my_struct_field: String,
}

The program will panic with an error that myStructField does not exist. This is correct because config will by default lowercase all the keys. This creates a scenario where it's not possible to use serde deserializer to handle this, since there's no rename_all option that will fit this case.

I've seen this issue repeating multiple times, but didn't see an issue that suggests a way to solve this. I'm not too familiar with the internal implementation, but would it be possible to add an option to preserve the keys while building the configuration, for example by adding .add_source(config::File::with_name("src/settings.json").preserve_casing(true).required(false))?

If it should be possible, and it's accepted, I can try implementing this (unless there's some alternative to get through this).
We'd like to use the config library, but we have many JSON file configurations that this creates a lot of work to modify them, and the need to preserve the two versions of the JSON files for backward compatibilities.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions