Enum ConfigValue 

pub enum ConfigValue {
    Null,
    Bool(bool),
    Number(f64),
    String(String),
    Array(Vec<ConfigValue>),
    Object(Vec<(String, ConfigValue)>),
    Regex {
        pattern: String,
        flags: String,
    },
    Unknown,
    OneOf(Vec<ConfigValue>),
}

A statically known value from a config file.

Variants

Null

null.

Bool(bool)

true or false.

Number(f64)

A numeric literal.

String(String)

A string literal, or a string computed from known values (a template literal, a concatenation, a path).

Array(Vec<ConfigValue>)

An array literal; spreads of static arrays are flattened, anything else becomes ConfigValue::Unknown.

Object(Vec<(String, ConfigValue)>)

An object literal in source order. A spread of an unknown value is recorded as the key UNKNOWN_SPREAD, or OWN_SPREAD when the module computes the value itself.

Regex

A regular expression literal.

Fields

pattern: String

The pattern, without the slashes.

flags: String

The flags after the closing slash, in alphabetical order (gi).

Unknown

Anything that cannot be known without running the code.

OneOf(Vec<ConfigValue>)

One of these values, without knowing which: the branches of a condition that cannot be decided statically (process.env.CI ? 'github' : 'list'). There are at least two alternatives, all different, and none is ConfigValue::Unknown or another OneOf, though an array or object alternative may hold unknown parts. ConfigValue::is_unknown and ConfigValue::has_unknown count it as unknown, so code that does not ask for its ConfigValue::alternatives treats it as an unknown value.

Implementations

impl ConfigValue

pub fn is_spread_key(key: &str) -> bool

Whether key is a key an object records an unknown spread under, UNKNOWN_SPREAD or OWN_SPREAD.

pub fn get(&self, key: &str) -> Option<&ConfigValue>

The value of key when this is an object.

pub fn as_str(&self) -> Option<&str>

The string when this is a string.

pub fn as_array(&self) -> Option<&[ConfigValue]>

The elements when this is an array.

pub fn as_object(&self) -> Option<&[(String, ConfigValue)]>

The entries when this is an object.

pub fn as_regex(&self) -> Option<&str>

The pattern when this is a regular expression literal.

pub fn as_bool(&self) -> Option<bool>

The boolean when this is a boolean.

pub fn is_unknown(&self) -> bool

Whether the value is not known as one value: ConfigValue::Unknown, or ConfigValue::OneOf of several.

pub fn alternatives(&self) -> &[ConfigValue]

The values this may be: the alternatives of a ConfigValue::OneOf, or the value itself.

pub fn has_unknown(&self) -> bool

Whether the value, or anything inside it, is ConfigValue::Unknown or ConfigValue::OneOf.

Trait Implementations

impl Clone for ConfigValue

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ConfigValue

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ConfigValue

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ConfigValue

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for ConfigValue

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ConfigValue