Skip to main content

EnvParser

Struct EnvParser 

Source
pub struct EnvParser { /* private fields */ }
Expand description

Type-safe environment variable parser.

Collects errors during parsing so all issues can be reported at once.

Implementations§

Source§

impl EnvParser

Source

pub fn new() -> Self

Create a new parser with the RCH_ prefix.

Source

pub fn errors(&self) -> &[EnvError]

Get all accumulated errors.

Source

pub fn has_errors(&self) -> bool

Check if any errors occurred.

Source

pub fn take_errors(&mut self) -> Vec<EnvError>

Take ownership of errors.

Source

pub fn get_string(&mut self, name: &str, default: &str) -> Sourced<String>

Get a string value with default.

Source

pub fn get_bool(&mut self, name: &str, default: bool) -> Sourced<bool>

Get a boolean value with default.

Accepts: 1, true, yes, on (for true) 0, false, no, off, “” (for false)

Source

pub fn get_u32_range( &mut self, name: &str, default: u32, min: u32, max: u32, ) -> Sourced<u32>

Get a u32 value with default and range validation.

Source

pub fn get_u64_range( &mut self, name: &str, default: u64, min: u64, max: u64, ) -> Sourced<u64>

Get a u64 value with default and range validation.

Source

pub fn get_i32_range( &mut self, name: &str, default: i32, min: i32, max: i32, ) -> Sourced<i32>

Get an i32 value with default and range validation.

Source

pub fn get_f64_range( &mut self, name: &str, default: f64, min: f64, max: f64, ) -> Sourced<f64>

Get a f64 value with default and range validation.

Source

pub fn get_path( &mut self, name: &str, default: &str, must_exist: bool, ) -> Sourced<PathBuf>

Get a path value with ~ expansion.

If must_exist is true, records an error if the path doesn’t exist.

Source

pub fn get_log_level(&mut self, name: &str, default: &str) -> Sourced<String>

Get a log level value with validation.

Source

pub fn get_string_list( &mut self, name: &str, default: Vec<String>, ) -> Sourced<Vec<String>>

Get a comma-separated list of strings.

Source

pub fn get_optional_string(&mut self, name: &str) -> Sourced<Option<String>>

Get an optional string (None if not set or empty).

Trait Implementations§

Source§

impl Default for EnvParser

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more