Struct DisplayMetadata 

#[non_exhaustive]
pub struct DisplayMetadata {
    pub locale: String,
    pub name: String,
    pub description: Option<String>,
    pub rendering: Option<Value>,
    pub additional: IndexMap<String, Value>,
}

Available on crate feature sd-jwt only.

Display information for a type, per locale (§5.5).

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.

locale: String

The language tag.

name: String

The name of the type for end users.

description: Option<String>

A description for end users.

rendering: Option<Value>

Rendering information (simple, svg_templates), carried as data.

additional: IndexMap<String, Value>

Every other property.

Implementations

impl DisplayMetadata

pub fn new(locale: impl Into<String>, name: impl Into<String>) -> Self

Display information in locale naming the type name.

Trait Implementations

impl Clone for DisplayMetadata

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DisplayMetadata

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for DisplayMetadata

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for DisplayMetadata

impl PartialEq for DisplayMetadata

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

Equality operator ==.

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

Inequality operator !=.

impl PartialSchema for DisplayMetadata

Available on crate feature utoipa only.

fn schema() -> RefOr<Schema>

Return ref or schema of implementing type that can then be used to construct combined schemas.

impl Serialize for DisplayMetadata

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 DisplayMetadata

impl ToSchema for DisplayMetadata

Available on crate feature utoipa only.

fn name() -> Cow<'static, str>

Return name of the schema.

fn schemas(schemas: &mut Vec<(String, RefOr<Schema>)>)

Implement reference utoipa::openapi::schema::Schemas for this type.