Struct ApprovalPolicyConfig
pub struct ApprovalPolicyConfig {
pub required_group: Option<String>,
pub quorum: u32,
pub request_route: Option<String>,
pub escalation_route: Option<String>,
}Expand description
A named approval policy ([sop.approval.policies.<name>]) the broker enforces.
Fields§
§required_group: Option<String>Group whose members may satisfy this policy’s gate. None/empty = any
principal permitted by approval_mode (back-compat, no membership gate).
quorum: u32Distinct approvers required before the gate clears. 0/1 both mean a
single approval; >= 2 requires a quorum of distinct approver identities.
request_route: Option<String>Channel to deliver the INITIAL approval request to when a run parks at a
gate this policy governs, formatted channel:recipient (e.g.
discord.ops:123456789012345678). The channel names a configured channel
(the <channel>.<alias> / bare-<channel> key from the channel map); the
recipient is that channel’s addressee (a Discord channel id, a chat id,
etc.). Delivery is best-effort - the gate is the source of truth and a
delivery failure never blocks or clears it; approvals still come back
through the normal HTTP/WS/tool surfaces. None/empty = no out-of-band
request notice (today’s behavior: only the originating surface is notified).
This is a DISTINCT lifecycle event from escalation_route: the request goes
out when the run parks; the escalation goes out only if it later times out.
When configured, the route must use the channel:recipient format.
escalation_route: Option<String>Route to escalate to on timeout (the distinct “second route”). None/empty
re-surfaces to the same route (today’s Escalate behavior). When configured,
the route must use the channel:recipient format.
Implementations§
Source§impl ApprovalPolicyConfig
impl ApprovalPolicyConfig
Sourcepub fn configurable_prefix() -> &'static str
pub fn configurable_prefix() -> &'static str
Returns the #[prefix] value for this Configurable struct.
Sourcepub fn secret_fields(&self) -> Vec<SecretFieldInfo>
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>
Sourcepub fn encrypt_secrets(&mut self, store: &SecretStore) -> Result<()>
pub fn encrypt_secrets(&mut self, store: &SecretStore) -> Result<()>
Encrypt all secret fields in place using the provided store.
Sourcepub fn decrypt_secrets(&mut self, store: &SecretStore) -> Result<()>
pub fn decrypt_secrets(&mut self, store: &SecretStore) -> Result<()>
Decrypt all secret fields in place using the provided store.
Sourcepub fn set_secret(&mut self, name: &str, value: String) -> Result<()>
pub fn set_secret(&mut self, name: &str, value: String) -> Result<()>
Set a secret field by its full dotted name, dispatching to nested children.
Sourcepub fn prop_fields(&self) -> Vec<PropFieldInfo>
pub fn prop_fields(&self) -> Vec<PropFieldInfo>
Returns metadata about all property fields on this struct and nested children.
Sourcepub fn get_prop(&self, name: &str) -> Result<String>
pub fn get_prop(&self, name: &str) -> Result<String>
Get a property value by its full dotted name, returning it as a display string.
Sourcepub fn set_prop(&mut self, name: &str, value_str: &str) -> Result<()>
pub fn set_prop(&mut self, name: &str, value_str: &str) -> Result<()>
Set a property value by its full dotted name, parsing from string.
Sourcepub fn prop_is_secret(name: &str) -> bool
pub fn prop_is_secret(name: &str) -> bool
Check if a property name refers to a secret field (static, no instance needed).
Sourcepub fn init_defaults(&mut self, prefix: Option<&str>) -> Vec<&'static str>
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.
Sourcepub fn map_key_sections() -> Vec<MapKeySection>
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.
Sourcepub fn nested_section_help(name: &str) -> Option<&'static str>
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>
Sourcepub fn get_map_keys(&self, section_path: &str) -> Option<Vec<String>>
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§
Source§impl Clone for ApprovalPolicyConfig
impl Clone for ApprovalPolicyConfig
Source§fn clone(&self) -> ApprovalPolicyConfig
fn clone(&self) -> ApprovalPolicyConfig
1.0.0 (const: unstable) · §fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl Debug for ApprovalPolicyConfig
impl Debug for ApprovalPolicyConfig
Source§impl Default for ApprovalPolicyConfig
impl Default for ApprovalPolicyConfig
Source§fn default() -> ApprovalPolicyConfig
fn default() -> ApprovalPolicyConfig
Source§impl<'de> Deserialize<'de> for ApprovalPolicyConfig
impl<'de> Deserialize<'de> for ApprovalPolicyConfig
Source§fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
Source§impl JsonSchema for ApprovalPolicyConfig
impl JsonSchema for ApprovalPolicyConfig
Source§fn schema_id() -> Cow<'static, str>
fn schema_id() -> Cow<'static, str>
Source§fn json_schema(generator: &mut SchemaGenerator) -> Schema
fn json_schema(generator: &mut SchemaGenerator) -> Schema
Source§fn inline_schema() -> bool
fn inline_schema() -> bool
$ref keyword. Read moreSource§impl MaskSecrets for ApprovalPolicyConfig
impl MaskSecrets for ApprovalPolicyConfig
fn mask_secrets(&mut self)
fn restore_secrets_from(&mut self, current: &Self)
Auto Trait Implementations§
impl Freeze for ApprovalPolicyConfig
impl RefUnwindSafe for ApprovalPolicyConfig
impl Send for ApprovalPolicyConfig
impl Sync for ApprovalPolicyConfig
impl Unpin for ApprovalPolicyConfig
impl UnsafeUnpin for ApprovalPolicyConfig
impl UnwindSafe for ApprovalPolicyConfig
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
§impl<T> Instrument for T
impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read more