Struct ClaimMetadata 

#[non_exhaustive]
pub struct ClaimMetadata {
    pub path: ClaimPath,
    pub display: Vec<ClaimDisplay>,
    pub mandatory: Option<bool>,
    pub sd: Option<SdPolicy>,
    pub svg_id: Option<String>,
    pub additional: IndexMap<String, Value>,
}

Available on crate feature sd-jwt only.

Metadata for the claim or claims at a path (§5.6).

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.

path: ClaimPath

Which claim(s) this describes.

display: Vec<ClaimDisplay>

Display information per locale.

mandatory: Option<bool>

Whether the issuer must include the claim; None is omitted, which means false.

sd: Option<SdPolicy>

Whether the claim is selectively disclosable; None is omitted, which means SdPolicy::Allowed.

svg_id: Option<String>

The id of the claim in SVG templates.

additional: IndexMap<String, Value>

Every other property.

Implementations

impl ClaimMetadata

pub fn new(path: impl Into<ClaimPath>) -> Self

Metadata for the claim at path.

pub fn with_display(self, display: ClaimDisplay) -> Self

This metadata with display added.

pub fn with_mandatory(self, mandatory: bool) -> Self

This metadata with mandatory.

pub fn with_sd(self, sd: SdPolicy) -> Self

This metadata with sd.

pub fn with_svg_id(self, svg_id: impl Into<String>) -> Self

This metadata with svg_id.

pub fn is_mandatory(&self) -> bool

Whether the claim is mandatory: mandatory, false when omitted.

pub fn sd_policy(&self) -> SdPolicy

The selective disclosure policy: sd, SdPolicy::Allowed when omitted.

pub fn check(&self) -> Result<(), TypeMetadataError>

Checks the structure: a non-empty path, a well-formed svg_id not used with a null path component.

Errors

TypeMetadataError::InvalidClaimMetadata.

Trait Implementations

impl Clone for ClaimMetadata

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 ClaimMetadata

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ClaimMetadata

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for ClaimMetadata

impl PartialEq for ClaimMetadata

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

Equality operator ==.

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

Inequality operator !=.

impl PartialSchema for ClaimMetadata

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 ClaimMetadata

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 ClaimMetadata

impl ToSchema for ClaimMetadata

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.