Struct PluginEntryConfig 

pub struct PluginEntryConfig {
    pub name: String,
    pub config: HashMap<String, String>,
    pub egress_hosts: Vec<String>,
    pub egress_allow_private: Vec<String>,
}

Per-instance plugin config keyed by the host-derived PluginInstanceId config-entry key; values are secret so they encrypt at rest under the same adjacent .secret_key as every other secret.

Fields

name: String

config: HashMap<String, String>

egress_hosts: Vec<String>

Destinations this plugin instance may reach. Default: empty, which means no network reach at all — a transport permission such as http_client grants the surface, this field grants the destinations.

Entries are exact hosts (api.example.com, 10.0.0.5) or explicit suffix patterns (*.example.com, which matches subdomains but not the apex — list the apex separately if it is needed). A bare domain never implies its subdomains, and there is no * meaning “anywhere”. Ports are not part of an entry: granting a host grants every port on it.

Deliberately a plaintext sibling of the #[secret] config map and never inside it: the allowlist is the thing an operator audits, so it has to stay readable in the file they are auditing.

egress_allow_private: Vec<String>

Subset of egress_hosts additionally permitted to resolve to a private, loopback, or link-local address (a self-hosted Gitea, a LAN Nextcloud). Mirrors the allowed_private_hosts semantics the host tools already use.

This relaxes the address class only. It never widens egress_hosts — a host listed here but not there is still denied — and cloud metadata addresses stay refused regardless of what is listed, including through a configured security.nat64_prefixes translation. Unlike the tool-layer field, * is not accepted here.

Implementations

impl PluginEntryConfig

pub fn configurable_prefix() -> &'static str

Returns the #[prefix] value for this Configurable struct.

pub fn init_requires_explicit_config() -> bool

True when this struct has a required leaf field that a bare/ancestor-prefix init_defaults scaffold must not materialize (it would fill the field with its Rust Default, which prune_empty_leaves then strips on save, leaving a partial sub-table that fails strict reload). Explicitly targeting this section (or a descendant of it) still scaffolds regardless of this flag, so the section can be materialized for the operator to fill in.

pub fn secret_fields(&self) -> Vec<SecretFieldInfo>

Returns metadata about all #[secret] fields on this struct and nested children.

pub fn secret_field_terminals() -> Vec<&'static str>

pub fn encrypt_secrets(&mut self, store: &SecretStore) -> Result<(), Error>

Encrypt all secret fields in place using the provided store.

pub fn decrypt_secrets(&mut self, store: &SecretStore) -> Result<(), Error>

Decrypt all secret fields in place using the provided store.

pub fn set_secret(&mut self, name: &str, value: String) -> Result<(), Error>

Set a secret field by its full dotted name, dispatching to nested children.

pub fn prop_fields(&self) -> Vec<PropFieldInfo>

Returns metadata about all property fields on this struct and nested children.

pub fn get_prop(&self, name: &str) -> Result<String, Error>

Get a property value by its full dotted name, returning it as a display string.

pub fn set_prop(&mut self, name: &str, value_str: &str) -> Result<(), Error>

Set a property value by its full dotted name, parsing from string.

pub fn prop_is_secret(name: &str) -> bool

Check if a property name refers to a secret field (static, no instance needed).

pub fn init_defaults(&mut self, prefix: Option<&str>) -> Vec<&'static str>

Instantiate None nested sections whose prefix matches. Returns the prefixes that were initialized.

pub fn map_key_sections() -> Vec<MapKeySection>

Enumerate every map-keyed (HashMap<String, T>) and list-shaped (Vec<T>) section discoverable from this Configurable’s tree. The dashboard / CLI consume this to surface “+ Add” affordances without hardcoding the section list.

pub fn nested_section_help(name: &str) -> Option<&'static str>

Help blurb for a #[nested] field on this struct, sourced from the field-level /// docstring. Returns None for unknown names so callers can fall through to a different lookup.

pub fn nested_section_group(name: &str) -> Option<&'static str>

pub fn get_map_keys(&self, section_path: &str) -> Option<Vec<String>>

Return the current alias keys at section_path, or None if the path doesn’t resolve to a map-keyed section in this tree.

pub fn nested_option_entries(&self) -> Vec<NestedOptionEntry>

pub fn create_map_key( &mut self, section_path: &str, map_key: &str, ) -> Result<bool, String>

pub fn delete_map_key( &mut self, section_path: &str, map_key: &str, ) -> Result<bool, String>

pub fn rename_map_key( &mut self, section_path: &str, map_key: &str, new_key: &str, ) -> Result<bool, String>

Trait Implementations

impl Clone for PluginEntryConfig

fn clone(&self) -> PluginEntryConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PluginEntryConfig

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

Formats the value using the given formatter.

impl Default for PluginEntryConfig

fn default() -> PluginEntryConfig

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for PluginEntryConfig

fn deserialize<__D>( __deserializer: __D, ) -> Result<PluginEntryConfig, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for PluginEntryConfig

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 MaskSecrets for PluginEntryConfig

fn mask_secrets(&mut self)

fn restore_secrets_from(&mut self, current: &PluginEntryConfig)

impl Serialize for PluginEntryConfig

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

where __S: Serializer,

Serialize this value into the given Serde serializer.