Struct SupervisorConfig 

pub struct SupervisorConfig {
    pub supervisor: SupervisorRootConfig,
    pub policy: PolicyConfig,
    pub shutdown: ShutdownConfig,
    pub observability: ObservabilityConfig,
    pub ipc: Option<DashboardIpcConfig>,
}

Configuration file shape loaded from YAML.

Fields

supervisor: SupervisorRootConfig

Root supervisor declaration values.

policy: PolicyConfig

Runtime policy values.

shutdown: ShutdownConfig

Shutdown budget values.

observability: ObservabilityConfig

Observability switches and capacities.

ipc: Option<DashboardIpcConfig>

Optional target-side dashboard IPC configuration.

Trait Implementations

impl Clone for SupervisorConfig

fn clone(&self) -> SupervisorConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Config for SupervisorConfig

const META: Meta

A description of this configuration.

type Layer = SupervisorConfigLayer

A layer of Self (a potentially partial configuration).

fn from_layer(layer: Self::Layer) -> Result<Self, Error>

Tries to create Self from a layer and validates itself.

fn builder() -> Builder<Self>

Convenience builder to configure, load and merge multiple configuration sources. Sources specified earlier have a higher priority; later sources only fill in the gaps. After all sources have been loaded, the default values (usually specified with #[default = ...]) are merged (with the lowest priority).

fn from_file(path: impl Into<PathBuf>) -> Result<Self, Error>

Load the configuration from a single file.

impl ConfigSchema for SupervisorConfig

fn include_paths(layer: &<Self as Config>::Layer) -> Vec<PathBuf>

Returns child configuration paths declared by one loaded layer.

Arguments

• layer: Partially loaded supervisor configuration layer.

Returns

Returns an empty list because official supervisor templates stay in one root YAML file unless crate users wrap this type in their own project.

fn template_path_for_section(section_path: &[&str]) -> Option<PathBuf>

Overrides the generated template file path for a split nested section.

impl Debug for SupervisorConfig

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SupervisorConfig

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for SupervisorConfig

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

The name of the generated JSON Schema.

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

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

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.

impl PartialEq for SupervisorConfig

fn eq(&self, other: &SupervisorConfig) -> 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 SupervisorConfig

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<SupervisorConfig> for ConfigState

fn try_from(config: SupervisorConfig) -> Result<Self, Self::Error>

Converts a deserialized supervisor config into validated state.

type Error = SupervisorError

The type returned in the event of a conversion error.

impl StructuralPartialEq for SupervisorConfig