Expand description
Compile-time environment variable parsing utilities.
This crate provides macros and const functions for parsing environment variables at compile time. It enables reading and converting environment variables to numeric types during compilation, useful for configuration that needs to be baked into the binary.
§Features
- Const functions for parsing strings to integers (
parse_usize,parse_isize) - Macros for reading environment variables as numeric types at compile time
- Support for optional environment variables with default values
- Zero runtime overhead - all parsing happens at compile time
§Examples
// Read a required environment variable as usize (panics if not set or invalid)
// const THREADS: usize = env_usize!("THREAD_COUNT");
// Read with a default value
// const BUFFER_SIZE: usize = default_env_usize!("BUFFER_SIZE", 4096);
// Read as an Option (returns None if not set)
// const MAX_RETRIES: Option<usize> = option_env_usize!("MAX_RETRIES");Macros§
- default_
env - Returns a compile-time environment variable as a string slice, or a default value if not set.
- default_
env_ u16 - Returns a compile-time environment variable as a
u16, or a default value if not set. - default_
env_ u32 - Returns a compile-time environment variable as a
u32, or a default value if not set. - default_
env_ u64 - Returns a compile-time environment variable as a
u64, or a default value if not set. - default_
env_ usize - Returns a compile-time environment variable as a
usize, or a default value if not set. - env_
usize - Parses a compile-time environment variable as a
usize. - option_
env_ i8 - Returns a compile-time environment variable as an
Option<i8>. - option_
env_ i16 - Returns a compile-time environment variable as an
Option<i16>. - option_
env_ i32 - Returns a compile-time environment variable as an
Option<i32>. - option_
env_ i64 - Returns a compile-time environment variable as an
Option<i64>. - option_
env_ isize - Returns a compile-time environment variable as an
Option<isize>. - option_
env_ u16 - Returns a compile-time environment variable as an
Option<u16>. - option_
env_ u32 - Returns a compile-time environment variable as an
Option<u32>. - option_
env_ u64 - Returns a compile-time environment variable as an
Option<u64>. - option_
env_ usize - Returns a compile-time environment variable as an
Option<usize>.
Enums§
- Parse
IntError - Error type for integer parsing operations.
Functions§
- parse_
isize - Parses a string slice into an
isizeat compile time. - parse_
usize - Parses a string slice into a
usizeat compile time.