Struct StringEnvVar

pub(crate) struct StringEnvVar {
    value: String,
    redacted: bool,
}

An environment variable read as a string.

Fields

value: String

Value of the env var.

redacted: bool

Whether the env var is displayed redacted or not.

Implementations

impl StringEnvVar

An environment variable read as a string.

pub(super) fn new(var_name: &str, param: StringEnvVarParams) -> Self

Read the env var from the environment.

If not defined, read from a .env file. If still not defined, use the default.

Arguments

• var_name: &str - the name of the env var
• default_value: &str - the default value

Returns

• Self - the value

Example

#use cat_data_service::settings::StringEnvVar;

let var = StringEnvVar::new("MY_VAR", "default");
assert_eq!(var.as_str(), "default");

pub(super) fn new_optional(var_name: &str, redacted: bool) -> Option<Self>

New Env Var that is optional.

pub(super) fn new_as_enum<T: FromStr + Display + VariantNames>( var_name: &str, default: T, redacted: bool, ) -> T

where <T as FromStr>::Err: Display,

Convert an Envvar into the required Enum Type.

pub(super) fn new_as<T>(var_name: &str, default: T, min: T, max: T) -> T

where T: FromStr + Display + PartialOrd + Value, <T as FromStr>::Err: Display,

Convert an Envvar into an integer in the bounded range.

pub(crate) fn as_str(&self) -> &str

Get the read env var as a str.

Returns

• &str - the value

pub(crate) fn as_string(&self) -> String

Get the read env var as a str.

Returns

• &str - the value

Trait Implementations

impl Clone for StringEnvVar

fn clone(&self) -> StringEnvVar

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for StringEnvVar

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Display for StringEnvVar

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.