Struct MetadataEnvelope 

pub struct MetadataEnvelope {
    pub doc: Option<String>,
    pub aliases: Vec<String>,
    pub examples: Vec<String>,
    pub deprecated: Option<String>,
    pub role: Option<Role>,
}

Typed metadata envelope. Holds non-validation, non-rendering-critical information (docs, aliases, examples, deprecation, role). Per-scalar validation constraints live on the relevant scalar’s typed substructure, not here.

Fields

doc: Option<String>

Free-form documentation string.

aliases: Vec<String>

Alternative names this type is also known by.

examples: Vec<String>

Canonical-encoded example values, each as a JSON string. Empty = no examples. Stored as strings so metadata is self-contained on the type side and does not have to cross-reference an accompanying value tree.

deprecated: Option<String>

Deprecation message; None means not deprecated.

role: Option<Role>

Optional role annotation tagging a type with a consumer-facing intent.

Implementations

impl MetadataEnvelope

pub fn is_empty(&self) -> bool

Trait Implementations

impl Clone for MetadataEnvelope

fn clone(&self) -> MetadataEnvelope

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MetadataEnvelope

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

Formats the value using the given formatter.

impl Default for MetadataEnvelope

fn default() -> MetadataEnvelope

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for MetadataEnvelope

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for MetadataEnvelope

impl FromSchema for MetadataEnvelope

fn from_value(value: &SchemaValue) -> Result<MetadataEnvelope, FromSchemaError>

impl IntoSchema for MetadataEnvelope

fn type_id() -> TypeId

fn register_in(builder: &mut SchemaBuilder) -> SchemaType

fn to_value(&self) -> SchemaValue

impl PartialEq for MetadataEnvelope

fn eq(&self, other: &MetadataEnvelope) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for MetadataEnvelope

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.

impl StructuralPartialEq for MetadataEnvelope