Struct StringVar 

pub struct StringVar { /* private fields */ }

Bind one required string value.

Implementations

impl StringVar

pub fn new(name: impl Into<VariableName>) -> Self

Build a required string variable.

Examples found in repository

examples/service_settings.rs (line 16)

    fn bind<E: Environment>(binder: &Binder<E>) -> Result<Self, envbind::BindError> {
        Ok(Self {
            host: binder.bind(&StringVar::new("SERVICE_HOST").default("127.0.0.1"))?,
            port: binder.bind(
                &U16Var::new("SERVICE_PORT")
                    .default(8080)
                    .validate(validators::u16_in_range(1, 65_535)),
            )?,
            service_name: binder.bind(&StringVar::new("SERVICE_NAME").default("api"))?,
            tracing_enabled: binder.bind(&BoolVar::new("SERVICE_TRACING").default(false))?,
        })
    }

pub fn default(self, value: impl Into<String>) -> Self

Provide a fallback value when the variable is missing.

Examples found in repository

examples/service_settings.rs (line 16)

    fn bind<E: Environment>(binder: &Binder<E>) -> Result<Self, envbind::BindError> {
        Ok(Self {
            host: binder.bind(&StringVar::new("SERVICE_HOST").default("127.0.0.1"))?,
            port: binder.bind(
                &U16Var::new("SERVICE_PORT")
                    .default(8080)
                    .validate(validators::u16_in_range(1, 65_535)),
            )?,
            service_name: binder.bind(&StringVar::new("SERVICE_NAME").default("api"))?,
            tracing_enabled: binder.bind(&BoolVar::new("SERVICE_TRACING").default(false))?,
        })
    }

pub fn allow_empty(self) -> Self

Allow empty strings to pass through.

pub fn sensitive(self, value: bool) -> Self

Mark the value as safe to include in validation details.

pub fn max_bytes(self, value: usize) -> Self

Override the maximum accepted raw byte length.

pub fn validate<F>(self, validator: F) -> Self

where F: Fn(&str) -> Result<(), ValidationError> + Send + Sync + 'static,

Attach a validation rule.

Trait Implementations

impl Binding<String> for StringVar

fn bind<E: Environment>(&self, environment: &E) -> Result<String, BindError>

Load the value from the given environment.