Struct ConfigAttr

pub struct ConfigAttr {
    pub env_name: Option<String>,
    pub py_name: Option<String>,
}

Metadata describing how a configuration key is exposed across environments.

Each ConfigAttr entry defines how a Rust configuration key maps to external representations:

• env_name: the environment variable consulted by [init_from_env()] when loading configuration.
• py_name: the Python keyword argument accepted by monarch.configure(...) and returned by get_configuration().

All configuration keys should carry this meta-attribute via @meta(CONFIG = ConfigAttr { ... }).

Fields

env_name: Option<String>

Environment variable consulted by init_from_env().

py_name: Option<String>

Python kwarg name used by monarch.configure(...) and get_configuration().

Trait Implementations

impl AttrValue for ConfigAttr

fn display(&self) -> String

Display the value, typically using std::fmt::Display. This is called to show the output in human-readable form.

fn parse(s: &str) -> Result<Self, Error>

Parse a value from a string, typically using std::str::FromStr.

impl Clone for ConfigAttr

fn clone(&self) -> ConfigAttr

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ConfigAttr

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ConfigAttr

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Named for ConfigAttr

fn typename() -> &'static str

The globally unique type name for the type. This should typically be the fully qualified Rust name of the type.

fn typehash() -> u64

A globally unique hash for this type. TODO: actually enforce perfect hashing

fn typeid() -> TypeId

The TypeId for this type. TypeIds are unique only within a binary, and should not be used for global identification.

fn port() -> u64

The globally unique port for this type. Typed ports are in the range of 1<<63..1<<64-1.

fn arm(&self) -> Option<&'static str>

If the named type is an enum, this returns the name of the arm of the value self.

unsafe fn arm_unchecked(self_: *const ()) -> Option<&'static str>

An unsafe version of ‘arm’, accepting a pointer to the value, for use in type-erased settings.

impl Serialize for ConfigAttr

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

where __S: Serializer,

Serialize this value into the given Serde serializer.