Enum ConfigValue 

pub enum ConfigValue {
    Inline(String),
    Env(String),
}

A config value written inline or read from an environment variable.

With the serde feature it deserializes from "literal" or { env = "VAR_NAME" }, the same shape drizzle-kit and the CLI accept for dbCredentials.url.

Examples

use drizzle_types::ConfigValue;

let url = ConfigValue::Inline("postgres://localhost/app".into());
assert_eq!(url.resolve().unwrap(), "postgres://localhost/app");

Variants

Inline(String)

Value written inline in the config file.

Env(String)

Name of the environment variable to resolve.

Implementations

impl ConfigValue

pub fn resolve(&self) -> Result<String, ConfigValueError>

Returns the value, reading the environment variable for ConfigValue::Env.

Errors

Returns ConfigValueError::NotPresent if this is a ConfigValue::Env pointing to a variable that is not set, or ConfigValueError::NotUnicode if the variable is set but contains invalid UTF-8.

pub fn resolve_optional(&self) -> Result<Option<String>, ConfigValueError>

Returns the value, or None when a ConfigValue::Env variable is unset.

Errors

Returns ConfigValueError::NotUnicode if the env var is set but contains invalid UTF-8. Missing env vars resolve to Ok(None).

Trait Implementations

impl Clone for ConfigValue

fn clone(&self) -> ConfigValue

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<(), Error>

Formats the value using the given formatter.

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

Available on crate feature serde only.

fn deserialize<D>( deserializer: D, ) -> Result<ConfigValue, <D as Deserializer<'de>>::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for ConfigValue

impl JsonSchema for ConfigValue

Available on crate feature schemars only.

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

impl PartialEq for ConfigValue

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ConfigValue