Skip to main content

Module traits

Module traits 

Source

Structs§

ChannelInfo
Metadata for one channel type, as returned by [ChannelsConfig::channels].
IntegrationDescriptor
One row emitted by the Configurable derive’s integration_descriptor() method on structs annotated with #[integration(...)]. Used for nested toggleable configs (e.g. BrowserConfig, CronConfig) where the integration is “active” iff a named bool field on the struct is true.
MapKeySection
NestedOptionEntry
One row emitted by the Configurable derive’s nested_option_entries() method — every #[nested] Option<XConfig> field on a struct shows up here with its present bit and the per-field #[display_name = "..."] / #[description = "..."] metadata. The integrations registry consumes this verbatim instead of carrying its own per-field hand-list.
PropFieldInfo
Describes a single property field discovered via #[derive(Configurable)].
SecretFieldInfo
Describes a single secret field discovered via #[derive(Configurable)].
SelectItem
A menu item for OnboardUi::select, with an optional status badge (e.g. [configured] / [not set]) that backends render next to the label.

Enums§

Answer
Result of a single prompt — either the value the user chose, or a navigation signal. Backends return Answer::Back when the user presses the backend’s back key (Esc on ratatui / dialoguer). Callers rewind.
MapKeyKind
Stable wire-form for an addable section — a HashMap<String, T> (Map) or Vec<T> (List) field whose value type implements Configurable. The dashboard / CLI use this to surface + Add affordances without hardcoding the section list. Auto-discovered by the Configurable derive.
PropKind
Runtime type classification for config property values.

Constants§

MASKED_SECRET

Traits§

ChannelConfig
The trait for describing a channel
HasPropKind
Maps Rust types to PropKind at compile time. Scalars have explicit impls; the blanket impl catches everything else as PropKind::Enum.
MaskSecrets
Mask and restore secret fields on config structs.
OnboardUi
Prompt-surface the onboard orchestrator drives.
SecretField
Per-field secret operations the Configurable derive emits for every #[secret] field. Generalizes mask / restore / encrypt / decrypt / is_set across the supported shapes — String, Option<String>, Vec<String>, HashMap<String, String>, and Option<HashMap<String, String>> — so adding a new shape is a single trait impl rather than a fourth branch in the macro.

Functions§

is_masked_secret