Enum ConfigValue 

pub enum ConfigValue {
    String(String),
    StringArray(Vec<String>),
}

API-facing configuration value.

Variants

String(String)

Scalar string value.

StringArray(Vec<String>)

JSON string-list value.

Implementations

impl ConfigValue

pub const REDACTED: &'static str = "***REDACTED***"

Redacted value used when presenting sensitive configuration through APIs or audit logs.

pub fn from_storage( value_type: impl Into<ConfigValueType>, value: String, ) -> Result<Self>

Converts a storage string into an API-facing value for value_type.

Errors

Returns [ConfigError] when the stored string does not match the declared value type.

pub fn from_storage_lossy( value_type: impl Into<ConfigValueType>, value: String, on_invalid: impl FnOnce(&ConfigCoreError), ) -> Self

Converts a storage string into an API-facing value and falls back to an empty value on malformed stored data.

Products should still validate writes strictly. This helper is for read/presentation paths where a single bad database row should not break the entire admin config page.

pub fn redacted() -> Self

Returns the canonical redacted API value.

pub fn empty_for_type(value_type: impl Into<ConfigValueType>) -> Self

Returns the empty API value appropriate for a declared value type.

pub fn is_empty(&self) -> bool

Returns whether this value is logically empty.

pub fn to_storage_for_type( &self, value_type: impl Into<ConfigValueType>, ) -> Result<String>

Converts an API-facing value into a storage string for value_type.

Errors

Returns [ConfigError] when the typed value does not match the requested storage type.

pub fn to_audit_string(&self) -> String

Converts the value into an audit-friendly string.

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 ComposeSchema for ConfigValue

fn compose(generics: Vec<RefOr<Schema>>) -> RefOr<Schema>

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 From<&String> for ConfigValue

fn from(value: &String) -> Self

Converts to this type from the input type.

impl From<&str> for ConfigValue

fn from(value: &str) -> Self

Converts to this type from the input type.

impl From<String> for ConfigValue

fn from(value: String) -> Self

Converts to this type from the input type.

impl From<Vec<String>> for ConfigValue

fn from(value: Vec<String>) -> Self

Converts to this type from the input type.

impl PartialEq for ConfigValue

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

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 ToSchema for ConfigValue

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

Return name of the schema.

fn schemas(schemas: &mut Vec<(String, RefOr<Schema>)>)

Implement reference [utoipa::openapi::schema::Schema]s for this type.

impl Eq for ConfigValue

impl StructuralPartialEq for ConfigValue