Code Monkey home page Code Monkey logo

derive-environment's Introduction

A Rust library for modifying structs via environment variables.

Unlike envy, this does not create a new object. It is used to reconfigure an existing structure (after having parsed it from a config file, for example).

Ignored fields

If a certain field should not be configurable via environment variables, mark it with #[env(ignore)].

Examples

Creating a config structure:

use derive_environment::FromEnv;

#[derive(Default, FromEnv)]
pub struct Config {
    // ...
}

// Creates a base configuration struct to add on to.
// Normally this would be created using `serde` from a config file.
let mut config = Config::default();
// Names the struct "MY_CONFIG", which acts as a prefix.
config.with_env("MY_CONFIG").unwrap();

Nesting fields:

use derive_environment::FromEnv;

#[derive(FromEnv)]
struct ServerConfig {
    port: u16,
}

#[derive(FromEnv)]
pub struct Config {
    server: ServerConfig,
}

Generates:

  • MY_CONFIG_SERVER_PORT

Vector of Nested fields:

use derive_environment::FromEnv;

// `Vec`'s `FromEnv` implementation requires `Default`.
#[derive(Default, FromEnv)]
struct ServerConfig {
    port: u16,
}

#[derive(FromEnv)]
pub struct Config {
    servers: Vec<ServerConfig>,
}

Generates:

  • MY_CONFIG_SERVER_0_PORT

derive-environment's People

Contributors

eievui5 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.