Struct EnvelopedVc 

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

Available on crate feature vc only.

An EnvelopedVerifiableCredential (VCDM 2.0 §4.12.1): a secured credential carried in a data: URL, the form a credential takes inside a PresentationV2.

Examples

use identity_kit::vc::{EnvelopedVc, Jwt};

let jwt: Jwt = "eyJhbGciOiJFZERTQSJ9.RXhhbXBsZSBvZiBFZDI1NTE5IHNpZ25pbmc.\
    hgyY0il_MGCjP0JzlnLWG1PPOt7-09PGcvMg3AIbQR6dWbhijcNR4ki4iylGjg5BhVsPt9g7sVvpAr_MuM0KAg"
    .parse()?;
let enveloped = EnvelopedVc::from_jwt(&jwt);
assert_eq!(enveloped.media_type(), "application/vc+jwt");
assert_eq!(enveloped.to_jwt()?, jwt);
assert_eq!(
    serde_json::to_value(&enveloped)?["type"],
    "EnvelopedVerifiableCredential"
);

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 EnvelopedVc

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

where __S: Serializer,

impl<'de> EnvelopedVc

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

where __D: Deserializer<'de>,

impl EnvelopedVc

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

The type.

pub const JWT_MEDIA_TYPE: &'static str = CredentialV2::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.

impl EnvelopedVc

pub const SD_JWT_MEDIA_TYPE: &'static str = crate::sd_jwt_vc::SdJwtCredentialV2::MEDIA_TYPE

Available on crate feature sd-jwt only.

The media type of a credential secured with SD-JWT (VC-JOSE-COSE §3.2.1), application/vc+sd-jwt.

pub fn from_sd_jwt(sd_jwt: &SdJwt) -> Self

Available on crate feature sd-jwt only.

An envelope for sd_jwt, in its compact serialization.

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

Available on crate feature sd-jwt only.

The SD-JWT the envelope holds, parsed but not processed; see SdJwtCredentialV2::from_sd_jwt for the credential it secures.

Errors

CredentialError::UnsupportedMediaType when the media type is not application/vc+sd-jwt, and CredentialError::InvalidClaim when the data is not an SD-JWT.

pub fn is_sd_jwt(&self) -> bool

Available on crate feature sd-jwt only.

Whether the envelope holds a credential secured with SD-JWT: its media type is application/vc+sd-jwt.

Trait Implementations

impl Clone for EnvelopedVc

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 EnvelopedVc

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for EnvelopedVc

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 EnvelopedVc

impl PartialEq for EnvelopedVc

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for EnvelopedVc

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

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for EnvelopedVc