envigil 0.4.0

Keep vigil over your environment — load, parse, and validate env vars with zero dependencies.
Documentation
//! Validation — built-in and custom validators.
//!
//! Demonstrates every built-in validator, including the ones added in
//! 0.2.0 (`length`, `ip`, `file_exists`) and 0.4.0 (`hostname`, `host`,
//! `url`, `email`, `one_of`, `port`, `privileged_port`, `user_port`).
//!
//! Run: cargo run --example validation
//!
//! Or override values:
//!   `APP_EMAIL=user@example.com` `APP_BIND_IP=10.0.0.5` \
//!     cargo run --example validation

use envigil::validate::{self, Validator};
use envigil::{EnvSource, VarBuilder};

/// Custom validator example: only even numbers.
struct EvenOnly;

impl Validator<u32> for EvenOnly {
    fn validate(&self, value: &u32) -> Result<(), String> {
        if value % 2 == 0 {
            Ok(())
        } else {
            Err(format!("{value} is odd"))
        }
    }
}

fn main() -> Result<(), envigil::Error> {
    let cfg = EnvSource::new()
        .prefix("APP_")
        // ── Core validators ──────────────────────────────────────
        .declare(
            VarBuilder::new("WORKERS", |v| v.parse::<u32>().map_err(|e| e.to_string()))
                .default(4)
                .validate(validate::range(1..=128))
                .validate(EvenOnly),
        )
        .declare(
            VarBuilder::new("EMAIL", |v| Ok(v.to_owned()))
                .default("dev@localhost".to_owned())
                .validate(validate::not_empty())
                .validate(validate::contains("@")),
        )
        .declare(
            VarBuilder::new("DSN", |v| Ok(v.to_owned()))
                .default("postgres://localhost/dev".to_owned())
                .validate(validate::starts_with("postgres://")),
        )
        .declare(
            VarBuilder::new("API_KEY", |v| Ok(v.to_owned()))
                .default("abcd-1234-efgh".to_owned())
                .validate(validate::length(8..=64)),
        )
        // ── Network validators ───────────────────────────────────
        .declare(
            VarBuilder::new("BIND_IP", |v| Ok(v.to_owned()))
                .default("127.0.0.1".to_owned())
                .validate(validate::ip()),
        )
        .declare(
            VarBuilder::new("DB_HOST", |v| Ok(v.to_owned()))
                .default("db.example.com".to_owned())
                .validate(validate::hostname()),
        )
        .declare(
            VarBuilder::new("CACHE_HOST", |v| Ok(v.to_owned()))
                .default("127.0.0.1".to_owned())
                .validate(validate::host()),
        )
        .declare(
            VarBuilder::new("WEBHOOK_URL", |v| Ok(v.to_owned()))
                .default("https://hooks.example.com/notify".to_owned())
                .validate(validate::url()),
        )
        .declare(
            VarBuilder::new("ADMIN_EMAIL", |v| Ok(v.to_owned()))
                .default("admin@example.com".to_owned())
                .validate(validate::email()),
        )
        // ── Port validators ──────────────────────────────────────
        .declare(
            VarBuilder::new("PORT", |v| v.parse::<u16>().map_err(|e| e.to_string()))
                .default(8080u16)
                .validate(validate::port()),
        )
        .declare(
            VarBuilder::new("HTTP_PORT", |v| v.parse::<u16>().map_err(|e| e.to_string()))
                .default(80u16)
                .validate(validate::privileged_port()),
        )
        .declare(
            VarBuilder::new("APP_PORT", |v| v.parse::<u16>().map_err(|e| e.to_string()))
                .default(8080u16)
                .validate(validate::user_port()),
        )
        // ── Enum validator ───────────────────────────────────────
        .declare(
            VarBuilder::new("LOG_LEVEL", |v| Ok(v.to_owned()))
                .default("info".to_owned())
                .validate(validate::one_of(["debug", "info", "warn", "error"])),
        )
        // ── Filesystem ───────────────────────────────────────────
        .declare(
            VarBuilder::new("CONFIG_FILE", |v| Ok(v.to_owned()))
                .default("Cargo.toml".to_owned())
                .validate(validate::file_exists()),
        )
        .load()?;

    println!("workers:      {}", cfg.get::<u32>("APP_WORKERS")?);
    println!("email:        {}", cfg.get::<String>("APP_EMAIL")?);
    println!("dsn:          {}", cfg.get::<String>("APP_DSN")?);
    println!("api_key:      {}", cfg.get::<String>("APP_API_KEY")?);
    println!("bind_ip:      {}", cfg.get::<String>("APP_BIND_IP")?);
    println!("db_host:      {}", cfg.get::<String>("APP_DB_HOST")?);
    println!("cache_host:   {}", cfg.get::<String>("APP_CACHE_HOST")?);
    println!("webhook_url:  {}", cfg.get::<String>("APP_WEBHOOK_URL")?);
    println!("admin_email:  {}", cfg.get::<String>("APP_ADMIN_EMAIL")?);
    println!("port:         {}", cfg.get::<u16>("APP_PORT")?);
    println!("http_port:    {}", cfg.get::<u16>("APP_HTTP_PORT")?);
    println!("app_port:     {}", cfg.get::<u16>("APP_APP_PORT")?);
    println!("log_level:    {}", cfg.get::<String>("APP_LOG_LEVEL")?);
    println!("config_file:  {}", cfg.get::<String>("APP_CONFIG_FILE")?);

    Ok(())
}