Struct identity_iota::credential::Presentation

pub struct Presentation<CRED, T = BTreeMap<String, Value>> {
    pub context: OneOrMany<Context>,
    pub id: Option<Url>,
    pub types: OneOrMany<String>,
    pub verifiable_credential: Vec<CRED>,
    pub holder: Url,
    pub refresh_service: OneOrMany<RefreshService>,
    pub terms_of_use: OneOrMany<Policy>,
    pub properties: T,
    pub proof: Option<Proof>,
}

Represents a bundle of one or more Credentials.

Fields

context: OneOrMany<Context>

The JSON-LD context(s) applicable to the Presentation.

id: Option<Url>

A unique URI that may be used to identify the Presentation.

types: OneOrMany<String>

One or more URIs defining the type of the Presentation.

verifiable_credential: Vec<CRED>

Credential(s) expressing the claims of the Presentation.

holder: Url

The entity that generated the Presentation.

refresh_service: OneOrMany<RefreshService>

Service(s) used to refresh an expired Credential in the Presentation.

terms_of_use: OneOrMany<Policy>

Terms-of-use specified by the Presentation holder.

properties: T

Miscellaneous properties.

proof: Option<Proof>

Optional cryptographic proof, unrelated to JWT.

Implementations

impl<CRED, T> Presentation<CRED, T>

pub fn base_context() -> &'static Context

Returns the base JSON-LD context for Presentations.

pub const fn base_type() -> &'static str

Returns the base type for Presentations.

pub fn builder(holder: Url, properties: T) -> PresentationBuilder<CRED, T>

Creates a PresentationBuilder to configure a new Presentation.

This is the same as PresentationBuilder::new.

pub fn from_builder( builder: PresentationBuilder<CRED, T>, ) -> Result<Presentation<CRED, T>, Error>

Returns a new Presentation based on the PresentationBuilder configuration.

pub fn check_structure(&self) -> Result<(), Error>

Validates the semantic structure of the Presentation.

Warning

This does not check the semantic structure of the contained credentials. This needs to be done as part of signature validation on the credentials as they are encoded as JWTs.

pub fn serialize_jwt( &self, options: &JwtPresentationOptions, ) -> Result<String, Error>

where T: ToOwned<Owned = T> + Serialize + DeserializeOwned, CRED: ToOwned<Owned = CRED> + Serialize + DeserializeOwned + Clone,

Serializes the Presentation as a JWT claims set in accordance with VC Data Model v1.1.

The resulting string can be used as the payload of a JWS when issuing the credential.

pub fn set_proof(&mut self, proof: Option<Proof>)

Sets the value of the proof property.

Note that this proof is not related to JWT.

Trait Implementations

impl<CRED, T> Clone for Presentation<CRED, T>

where CRED: Clone, T: Clone,

fn clone(&self) -> Presentation<CRED, T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<CRED, T> Debug for Presentation<CRED, T>

where CRED: Debug, T: Debug,

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

Formats the value using the given formatter.

impl<'de, CRED, T> Deserialize<'de> for Presentation<CRED, T>

where CRED: DeserializeOwned, T: Deserialize<'de>,

fn deserialize<__D>( __deserializer: __D, ) -> Result<Presentation<CRED, T>, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T> Display for Presentation<T>

where T: Serialize,

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

Formats the value using the given formatter.

impl<CRED, T> PartialEq for Presentation<CRED, T>

where CRED: PartialEq, T: PartialEq,

fn eq(&self, other: &Presentation<CRED, T>) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<CRED, T> Serialize for Presentation<CRED, T>

where CRED: Serialize, T: Serialize,

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<CRED, T> Eq for Presentation<CRED, T>

where CRED: Eq, T: Eq,

impl<CRED, T> StructuralPartialEq for Presentation<CRED, T>