envie - v1.0.0

envie

Values

all

</> 
pub fn all() -> dict.Dict(String, String)

Return all environment variables as a Dict(String, String).

format_error

</> 
pub fn format_error(err: error.Error) -> String

Format a single Error for display.

format_errors

</> 
pub fn format_errors(errors: List(error.Error)) -> String

Format multiple Error values, one per line.

format_load_error

</> 
pub fn format_load_error(err: error.LoadError) -> String

Format a LoadError for display.

get

</> 
pub fn get(name: String) -> Result(String, Nil)

Return the variable’s value as Ok(value), or Error(Nil) if missing.

get_bool

</> 
pub fn get_bool(name: String, default: Bool) -> Bool

Get a boolean variable; returns default if missing or unrecognised. Accepted truthy: true, yes, 1, on. Falsy: false, no, 0, off.

get_float

</> 
pub fn get_float(name: String, default: Float) -> Float

Get a float variable; return default if missing or invalid.

get_int

</> 
pub fn get_int(name: String, default: Int) -> Int

Get an integer variable; return default if missing or invalid.

get_string

</> 
pub fn get_string(name: String, default: String) -> String

Get a string variable, fall back to default when missing.

get_string_list

</> 
pub fn get_string_list(
  name: String,
  separator separator: String,
  default default: List(String),
) -> List(String)

Split a variable by separator into trimmed, non-empty strings.

load

</> 
pub fn load() -> Result(Nil, error.LoadError)

Load variables from .env in the current directory; does not overwrite existing vars.

load_from

</> 
pub fn load_from(path: String) -> Result(Nil, error.LoadError)

Load variables from path; existing environment variables are preserved.

load_from_string

</> 
pub fn load_from_string(
  content: String,
) -> Result(Nil, error.LoadError)

Load variables from .env formatted content; does not overwrite by default.

load_from_string_override

</> 
pub fn load_from_string_override(
  content: String,
) -> Result(Nil, error.LoadError)

Load variables from content, overwriting existing variables.

load_override

</> 
pub fn load_override() -> Result(Nil, error.LoadError)

Like load, but overwrite existing variables with .env values.

load_override_from

</> 
pub fn load_override_from(
  path: String,
) -> Result(Nil, error.LoadError)

Load from path, overwriting existing variables.

optional

</> 
pub fn optional(
  name: String,
  decoder: decode.Decoder(a),
) -> Result(option.Option(a), error.Error)

Decode an optional variable: Ok(None) if missing, Ok(Some(v)) if valid, otherwise Error.

parse_dotenv

</> 
pub fn parse_dotenv(
  content: String,
) -> Result(List(#(String, String)), List(error.ParseError))

Parse .env content into key/value pairs; returns parse errors if any.

require

</> 
pub fn require(
  name: String,
  decoder: decode.Decoder(a),
) -> Result(a, error.Error)

Require a variable and decode it with decoder. Returns Ok(value) or an Error describing missing/invalid input.

require_bool

</> 
pub fn require_bool(name: String) -> Result(Bool, error.Error)

Require a boolean variable. Accepts the usual true/false aliases.

require_float

</> 
pub fn require_float(name: String) -> Result(Float, error.Error)

Require a float variable.

require_float_range

</> 
pub fn require_float_range(
  name: String,
  min min: Float,
  max max: Float,
) -> Result(Float, error.Error)

Require a float within [min, max].

require_int

</> 
pub fn require_int(name: String) -> Result(Int, error.Error)

Require an integer variable.

require_int_list

</> 
pub fn require_int_list(
  name: String,
  separator separator: String,
) -> Result(List(Int), error.Error)

Require a list of integers split by separator.

require_int_range

</> 
pub fn require_int_range(
  name: String,
  min min: Int,
  max max: Int,
) -> Result(Int, error.Error)

Require an integer within [min, max].

require_non_empty_string

</> 
pub fn require_non_empty_string(
  name: String,
) -> Result(String, error.Error)

Require a non-empty (trimmed) string.

require_one_of

</> 
pub fn require_one_of(
  name: String,
  allowed: List(String),
) -> Result(String, error.Error)

Require that a variable equals one of the allowed strings.

require_port

</> 
pub fn require_port(name: String) -> Result(Int, error.Error)

Require a TCP/UDP port number (1–65535).

require_string

</> 
pub fn require_string(
  name: String,
) -> Result(String, error.Error)

Require a string variable.

require_string_list

</> 
pub fn require_string_list(
  name: String,
  separator separator: String,
) -> Result(List(String), error.Error)

Require a list of strings split by separator.

require_string_prefix

</> 
pub fn require_string_prefix(
  name: String,
  prefix prefix: String,
) -> Result(String, error.Error)

Require a string that starts with prefix.

require_url

</> 
pub fn require_url(name: String) -> Result(uri.Uri, error.Error)

Require a valid URL (permissive).

require_url_with_scheme

</> 
pub fn require_url_with_scheme(
  name: String,
  schemes: List(String),
) -> Result(uri.Uri, error.Error)

Require a URL that has one of the given schemes.

require_web_url

</> 
pub fn require_web_url(
  name: String,
) -> Result(uri.Uri, error.Error)

Shortcut for require_url_with_scheme(name, ["http", "https"]).

set

</> 
pub fn set(name: String, value: String) -> Nil

Set an environment variable.

unset

</> 
pub fn unset(name: String) -> Nil

Remove an environment variable, if present.

✨ Search Document