Struct Parser

pub struct Parser {
    pub prefix: Option<String>,
    pub separator: String,
    pub include: Vec<Regex>,
    pub exclude: Vec<Regex>,
    pub json: Value,
}

Parse environment variables into json

Fields

prefix: Option<String>

The prefix to use when parsing environment variables

separator: String

The separator to use when parsing environment variables

include: Vec<Regex>

Available on crate feature filter only.

List of regex patterns to include. One of the patterns must match for the variable to be included

exclude: Vec<Regex>

Available on crate feature filter only.

List of regex patterns to exclude. All of the patterns must not match for the variable to be included

json: Value

The json object to merge the parsed environment variables into

Implementations

impl Parser

pub fn with_prefix(self, prefix: impl Into<String>) -> Self

Return a new parser with the given prefix

pub fn with_separator(self, separator: impl Into<String>) -> Self

Return a new parser with the given separator

pub fn with_include(self, include: &[&str]) -> Self

Available on crate feature filter only.

Return a new parser with the given include patterns Requires the filter feature

pub fn with_exclude(self, exclude: &[&str]) -> Self

Available on crate feature filter only.

Return a new parser with the given exclude patterns

pub fn with_json(self, json: Value) -> Self

Return a new parser with the given json object

pub fn parse_from_env(&self) -> Result<Value, Error>

Parse environment variables into json

pub fn parse_iter( &self, vars: impl Iterator<Item = (String, String)>, ) -> Result<Value, Error>

Parse iterator of String tuples into json

pub fn json_get_mut<'a>( json: &'a mut Value, indices: &'a [JsonIndex], ) -> Option<&'a mut Value>

Get mutable reference to json value at indices

Trait Implementations

impl Debug for Parser

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

Formats the value using the given formatter.

impl Default for Parser

fn default() -> Self

Returns the “default value” for a type.