Struct EnvelopedVp 

#[non_exhaustive]
pub struct EnvelopedVp {
    pub context: Context,
    pub id: Uri,
    pub types: OneOrMany<String>,
}

Available on crate feature vc only.

An EnvelopedVerifiablePresentation (VCDM 2.0 §4.12.2): a secured presentation carried in a data: URL.

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, which must define the type; the base context does.

id: Uri

The data: URL holding the secured form.

types: OneOrMany<String>

type, including the enveloped type.

Implementations

impl EnvelopedVp

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

where __S: Serializer,

impl<'de> EnvelopedVp

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

where __D: Deserializer<'de>,

impl EnvelopedVp

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

The type.

pub const JWT_MEDIA_TYPE: &'static str = PresentationV2::JWT_MEDIA_TYPE

The media type of the JWT form this crate reads.

pub fn new(media_type: &str, data: &str) -> Result<Self, CredentialError>

An envelope for data of media_type, in the base context.

data is placed in the URL as is; a JWT needs no encoding, other media types may.

Errors

CredentialError::InvalidClaim for id when media_type or data holds a character a URI cannot.

pub fn from_jwt(jwt: &Jwt) -> Self

An envelope for jwt.

pub fn media_type(&self) -> &str

The media type of the data: URL.

pub fn data(&self) -> &str

The data of the data: URL, as written.

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

The JWT the envelope holds.

Errors

CredentialError::UnsupportedMediaType when the media type is not the JWT one, and CredentialError::InvalidClaim when the data is not a JWT.

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

Checks that type includes the enveloped type and id is a data: URL.

Errors

CredentialError::MissingType or CredentialError::NotDataUrl.

Trait Implementations

impl Clone for EnvelopedVp

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 EnvelopedVp

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for EnvelopedVp

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

Reads the object and checks its type and that id is a data: URL.

impl Eq for EnvelopedVp

impl PartialEq for EnvelopedVp

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

Equality operator ==.

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

Inequality operator !=.

impl PartialSchema for EnvelopedVp

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 EnvelopedVp

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

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for EnvelopedVp

impl ToSchema for EnvelopedVp

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.