Struct FieldSecurityMetadata 

#[non_exhaustive]
pub struct FieldSecurityMetadata {
    pub encrypted: Option<bool>,
    pub requires_scope: Option<String>,
    pub on_deny: Option<String>,
    pub requires_role: Option<String>,
}

Security metadata for a single field or type in the compiled schema.

Only non-default annotations are populated; all fields are Option and serialise with skip_serializing_if = "Option::is_none" so that the JSON output is minimal.

The struct is #[non_exhaustive] to allow adding new annotation kinds in future releases without breaking downstream pattern matches.

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.

encrypted: Option<bool>

true when this field is encrypted at rest.

Only present (and always true) for fields that carry an FieldEncryptionConfig. Absent when the field is not encrypted.

requires_scope: Option<String>

OAuth 2.0 scope required to read this field.

When None, the field is visible to any authenticated user (subject to type-level requires_role).

on_deny: Option<String>

Policy applied when the required scope is absent.

Possible values: "reject", "mask". Only serialised when the policy is non-default (i.e., not "reject").

requires_role: Option<String>

Role required to access this type (type-level guard).

Only present on type-keyed entries (keys without a . separator).

Implementations

impl FieldSecurityMetadata

pub const fn is_empty(&self) -> bool

Returns true if all annotations are absent (entry should be omitted).

Trait Implementations

impl Clone for FieldSecurityMetadata

fn clone(&self) -> FieldSecurityMetadata

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FieldSecurityMetadata

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

Formats the value using the given formatter.

impl PartialEq for FieldSecurityMetadata

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for FieldSecurityMetadata