Skip to main content

ParsedParamAttrs

Struct ParsedParamAttrs 

Source
pub struct ParsedParamAttrs {
    pub wire_name: Option<String>,
    pub location: Option<ParamLocation>,
    pub default_value: Option<String>,
    pub short_flag: Option<char>,
    pub help_text: Option<String>,
    pub positional: bool,
    pub env_var: Option<String>,
    pub file_key: Option<String>,
    pub nested: bool,
    pub env_prefix: Option<String>,
    pub nested_serde: bool,
}
Expand description

Parsed result of #[param(...)] attributes.

Fields§

§wire_name: Option<String>§location: Option<ParamLocation>§default_value: Option<String>§short_flag: Option<char>§help_text: Option<String>§positional: bool§env_var: Option<String>

Environment variable name (from #[param(env = "VAR")]). Used by #[derive(Config)].

§file_key: Option<String>

Config file key override (from #[param(file_key = "a.b.c")]). Used by #[derive(Config)].

§nested: bool

Marks a field as a nested Config sub-struct (from #[param(nested)]).

The field’s type must also #[derive(Config)]. TOML loading delegates to the child’s Config::load, using the field name (or file_key) as the sub-table name. Env var loading narrows the prefix with the field name.

§env_prefix: Option<String>

Env-var prefix override for a nested field (from #[param(env_prefix = "SEARCH")]).

When set, env vars for the child struct use {env_prefix}_{CHILD_FIELD} instead of {parent_prefix}_{field_name}_{CHILD_FIELD}. Only meaningful with nested.

§nested_serde: bool

Serde-passthrough flag for nested fields (from #[param(nested, serde)]).

When true (implies nested = true), the TOML sub-table for this field is deserialized via serde::Deserialize instead of Config::load. Env-var overrides are silently skipped for the serde-nested subtree; use #[serde(default)] in the child type for defaults. Only meaningful with nested.

Trait Implementations§

Source§

impl Clone for ParsedParamAttrs

Source§

fn clone(&self) -> ParsedParamAttrs

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 Debug for ParsedParamAttrs

Source§

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

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

impl Default for ParsedParamAttrs

Source§

fn default() -> ParsedParamAttrs

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

Auto Trait Implementations§

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, 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.