Skip to main content

ConfigValue

Enum ConfigValue 

Source
pub enum ConfigValue<T>{
    Secret {
        name: String,
    },
    EnvironmentVariable {
        name: String,
        default: Option<String>,
    },
    Static(T),
}
Expand description

A configuration value that can be a static value or a reference to be resolved at runtime.

This enum is the building block for plugin configuration DTOs. It supports three variants:

  • Static — A plain value of type T, provided directly in the configuration.
  • Secret — A reference to a named secret, resolved at runtime by the server.
  • EnvironmentVariable — A reference to an environment variable, with an optional default.

§Serialization

  • Static values serialize as the plain T value.
  • Secret serializes as {"kind": "Secret", "name": "..."}.
  • EnvironmentVariable serializes as {"kind": "EnvironmentVariable", "name": "...", "default": "..."}.

§Deserialization

Supports three input formats (see module docs for examples):

  1. Plain value → Static(T)
  2. POSIX ${VAR:-default} string → EnvironmentVariable { name, default }
  3. Structured {"kind": "...", ...}Secret or EnvironmentVariable

Variants§

§

Secret

A reference to a secret (resolved to string at runtime, then parsed to T).

Fields

§name: String
§

EnvironmentVariable

A reference to an environment variable.

Fields

§name: String
§default: Option<String>
§

Static(T)

A static value of type T.

Trait Implementations§

Source§

impl<T> Clone for ConfigValue<T>

Source§

fn clone(&self) -> ConfigValue<T>

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<T> Debug for ConfigValue<T>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<T> Default for ConfigValue<T>

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl<'de, T> Deserialize<'de> for ConfigValue<T>
where T: Serialize + DeserializeOwned + Clone + 'static,

Source§

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

Deserialize this value from the given Serde deserializer. Read more
Source§

impl<T> PartialEq for ConfigValue<T>

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl<T> Serialize for ConfigValue<T>

Source§

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
where S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl<T> StructuralPartialEq for ConfigValue<T>

Auto Trait Implementations§

§

impl<T> Freeze for ConfigValue<T>
where T: Freeze,

§

impl<T> RefUnwindSafe for ConfigValue<T>
where T: RefUnwindSafe,

§

impl<T> Send for ConfigValue<T>
where T: Send,

§

impl<T> Sync for ConfigValue<T>
where T: Sync,

§

impl<T> Unpin for ConfigValue<T>
where T: Unpin,

§

impl<T> UnsafeUnpin for ConfigValue<T>
where T: UnsafeUnpin,

§

impl<T> UnwindSafe for ConfigValue<T>
where T: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,