Struct SecretRequirement 

#[non_exhaustive]
pub struct SecretRequirement {
    pub key: SecretKey,
    pub required: bool,
    pub description: Option<String>,
    pub scope: Option<SecretScope>,
    pub format: Option<SecretFormat>,
    pub schema: Option<Value>,
    pub examples: Vec<String>,
}

Structured secret requirement used in capabilities, bindings, and deployment plans.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

key: SecretKey

Logical key the runtime should resolve.

required: bool

Whether the secret is mandatory for execution.

description: Option<String>

Optional description for operator-facing tooling.

scope: Option<SecretScope>

Expected scope for resolution (environment/tenant/team).

format: Option<SecretFormat>

Preferred secret format when known.

schema: Option<Value>

Optional JSON Schema fragment describing the value shape.

examples: Vec<String>

Example payloads for documentation.

Trait Implementations

impl Clone for SecretRequirement

fn clone(&self) -> SecretRequirement

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SecretRequirement

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

Formats the value using the given formatter.

impl Default for SecretRequirement

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for SecretRequirement

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for SecretRequirement

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for SecretRequirement

impl StructuralPartialEq for SecretRequirement