file_env_const

Crates.iofile_env_const
lib.rsfile_env_const
version0.3.0
sourcesrc
created_at2023-10-18 17:30:36.161571
updated_at2023-11-27 12:49:50.614576
descriptionmacros for loading data from files or environment variables at compile time
homepage
repositoryhttps://github.com/tveness/file_env_const
max_upload_size
id1006990
size12,571
(tveness)

documentation

README

file_env_const

Crates.io Documentation Build status License

This crate provides macros for loading data at compile time from a file or environment variable, with fallback options.

This is useful in the case of building a binary with hard-coded strings which you may wish to inject as environment variables in a build environment (say in CI), or store locally in a file when building offline, with a fallback option in either case.

Examples

Loading a file, with environment fallback

use file_env_const::file_env;
// Read data from file first
const FILE_DATA: &'static str = file_env!("Cargo.toml", "CARGO_PKG_NAME");
let f = std::fs::read_to_string("Cargo.toml").unwrap();
assert_eq!(FILE_DATA, f);

// Tries to read data from file, falls back to environment variable which is the package name
const FALL_BACK_TO_ENV: &'static str = file_env!("file_does_not_exist", "CARGO_PKG_NAME");
assert_eq!(FALL_BACK_TO_ENV, "file_env_const");

// Tries to read data from file, falls back to environment variable which is the package name
const FALL_BACK_TO_DEFAULT: &'static str =
    file_env!("file_does_not_exist", "ENV_NOT_FOUND", "fallback string");
assert_eq!(FALL_BACK_TO_DEFAULT, "fallback string");

Loading an environment variable, with file fallback

use file_env_const::env_file;
// Read data from file first
const ENV_DATA: &'static str = env_file!("CARGO_PKG_NAME", "Cargo.toml");
assert_eq!(ENV_DATA, "file_env_const");

// Tries to read data from file, falls back to environment variable which is the package name
const FALL_BACK_TO_FILE: &'static str = env_file!("ENV_NOT_FOUND", "Cargo.toml");
let f = std::fs::read_to_string("Cargo.toml").unwrap();
assert_eq!(FALL_BACK_TO_FILE, f);

// Tries to read data from file, falls back to environment variable which is the package name
const FALL_BACK_TO_DEFAULT: &'static str =
    env_file!( "ENV_NOT_FOUND", "file_does_not_exist", "fallback string");
assert_eq!(FALL_BACK_TO_DEFAULT, "fallback string");
Commit count: 13

cargo fmt