Struct PresentationV2 

#[non_exhaustive]
pub struct PresentationV2 {
    pub context: Context,
    pub id: Option<Uri>,
    pub types: OneOrMany<String>,
    pub holder: Option<Party>,
    pub verifiable_credential: Vec<EnvelopedVc>,
    pub properties: IndexMap<String, Value>,
}

Available on crate feature vc only.

A verifiable presentation of the Verifiable Credentials Data Model 2.0 whose credentials are EnvelopedVc objects, as data.

Secured per VC-JOSE-COSE, the presentation itself is the JWT payload, with typ: vp+jwt in the header; the holder signs it.

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.

context: Context

@context, starting with PresentationV2::CONTEXT.

id: Option<Uri>

The identifier of the presentation.

types: OneOrMany<String>

type, including PresentationV2::TYPE.

holder: Option<Party>

The holder presenting the credentials.

verifiable_credential: Vec<EnvelopedVc>

The presented credentials, each enveloped.

properties: IndexMap<String, Value>

Every other property, in insertion order.

Implementations

impl PresentationV2

pub fn serialize<__S>( __self: &PresentationV2, __serializer: __S, ) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

impl<'de> PresentationV2

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

where __D: Deserializer<'de>,

impl PresentationV2

pub const CONTEXT: &'static str = CONTEXT_V2

The base context, https://www.w3.org/ns/credentials/v2.

pub const TYPE: &'static str = "VerifiablePresentation"

The type every presentation has, VerifiablePresentation.

pub const JWT_TYP: &'static str = "vp+jwt"

The typ of a JWT securing a presentation, vp+jwt.

pub const JWT_MEDIA_TYPE: &'static str = "application/vp+jwt"

The media type of a JWT securing a presentation, application/vp+jwt.

pub fn new() -> Self

An empty presentation of type VerifiablePresentation in the base context.

pub fn with_context(self, context: impl Into<String>) -> Self

This presentation with context appended to its @context.

pub fn with_id(self, id: impl Into<Uri>) -> Self

This presentation with its id set.

pub fn with_type(self, presentation_type: impl Into<String>) -> Self

This presentation with presentation_type appended to its type.

pub fn with_holder(self, holder: impl Into<Party>) -> Self

This presentation with its holder set.

pub fn with_credential(self, credential: EnvelopedVc) -> Self

This presentation with credential added.

pub fn with_property( self, name: impl Into<String>, value: impl Into<Value>, ) -> Self

This presentation with the property name set to value.

pub fn has_type(&self, presentation_type: &str) -> bool

Whether presentation_type is among the types.

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

Checks that the first @context is the base context and type includes VerifiablePresentation.

Errors

The first CredentialError found.

pub fn to_jwt_claims(&self) -> JwtClaims

The JWT claims set securing the presentation (VC-JOSE-COSE §3.1.2): the presentation’s own properties. iss, aud, nonce and the rest are the caller’s to add.

pub fn from_jwt_claims(jwt_claims: &JwtClaims) -> Result<Self, CredentialError>

The presentation a JWT claims set secures, with iss and jti, when present, checked against holder and id.

Errors

As CredentialV2::from_jwt_claims.

Trait Implementations

impl Clone for PresentationV2

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 PresentationV2

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

Formats the value using the given formatter.

impl Default for PresentationV2

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for PresentationV2

fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error>

Reads the presentation and checks it with PresentationV2::check.

impl Eq for PresentationV2

impl PartialEq for PresentationV2

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

Equality operator ==.

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

Inequality operator !=.

impl PartialSchema for PresentationV2

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 PresentationV2

fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for PresentationV2

impl ToSchema for PresentationV2

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.