Struct Credential

pub struct Credential<T = BTreeMap<String, Value>> {

    pub context: OneOrMany<Context>,
    pub id: Option<Url>,
    pub types: OneOrMany<String>,
    pub credential_subject: OneOrMany<Subject>,
    pub issuer: Issuer,
    pub issuance_date: Timestamp,
    pub expiration_date: Option<Timestamp>,
    pub credential_status: Option<Status>,
    pub credential_schema: OneOrMany<Schema>,
    pub refresh_service: OneOrMany<RefreshService>,
    pub terms_of_use: OneOrMany<Policy>,
    pub evidence: OneOrMany<Evidence>,
    pub non_transferable: Option<bool>,
    pub properties: T,
    pub proof: Option<Proof>,
}

Represents a set of claims describing an entity.

Fields

context: OneOrMany<Context>

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

id: Option<Url>

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

types: OneOrMany<String>

One or more URIs defining the type of the Credential.

credential_subject: OneOrMany<Subject>

One or more Objects representing the Credential subject(s).

issuer: Issuer

A reference to the issuer of the Credential.

issuance_date: Timestamp

A timestamp of when the Credential becomes valid.

expiration_date: Option<Timestamp>

A timestamp of when the Credential should no longer be considered valid.

credential_status: Option<Status>

Information used to determine the current status of the Credential.

credential_schema: OneOrMany<Schema>

Information used to assist in the enforcement of a specific Credential structure.

refresh_service: OneOrMany<RefreshService>

Service(s) used to refresh an expired Credential.

terms_of_use: OneOrMany<Policy>

Terms-of-use specified by the Credential issuer.

evidence: OneOrMany<Evidence>

Human-readable evidence used to support the claims within the Credential.

non_transferable: Option<bool>

Indicates that the Credential must only be contained within a Presentation with a proof issued from the Credential subject.

properties: T

Miscellaneous properties.

proof: Option<Proof>

Optional cryptographic proof, unrelated to JWT.

Implementations

impl<T> Credential<T>

pub fn base_context() -> &'static Context

Returns the base JSON-LD context.

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

Returns the base type.

pub fn builder(properties: T) -> CredentialBuilder<T>

Creates a new CredentialBuilder to configure a Credential.

This is the same as CredentialBuilder::new.

pub fn from_builder( builder: CredentialBuilder<T>, ) -> Result<Credential<T>, Error>

Returns a new Credential based on the CredentialBuilder configuration.

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

Validates the semantic structure of the Credential.

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

Sets the proof property of the Credential.

Note that this proof is not related to JWT.

pub fn serialize_jwt( &self, custom_claims: Option<BTreeMap<String, Value>>, ) -> Result<String, Error>

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

Serializes the Credential 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 serialize_jpt( &self, custom_claims: Option<BTreeMap<String, Value>>, ) -> Result<JptClaims, Error>

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

Serializes the Credential as a JPT claims set

Trait Implementations

impl<T> Clone for Credential<T>

where T: Clone,

fn clone(&self) -> Credential<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T> Debug for Credential<T>

where T: Debug,

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

Formats the value using the given formatter.

impl<'de, T> Deserialize<'de> for Credential<T>

where T: Deserialize<'de>,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T> Display for Credential<T>

where T: Serialize,

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

Formats the value using the given formatter.

impl From<StatusList2021Credential> for Credential

fn from(value: StatusList2021Credential) -> Credential

Converts to this type from the input type.

impl<T> PartialEq for Credential<T>

where T: PartialEq,

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl<T> Serialize for Credential<T>

where 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 TryFrom<Credential> for StatusList2021Credential

type Error = StatusList2021CredentialError

The type returned in the event of a conversion error.

fn try_from( credential: Credential, ) -> Result<StatusList2021Credential, <StatusList2021Credential as TryFrom<Credential>>::Error>

Performs the conversion.

impl TryFrom<JwtCredential> for Credential

type Error = Error

The type returned in the event of a conversion error.

fn try_from( value: JwtCredential, ) -> Result<Credential, <Credential as TryFrom<JwtCredential>>::Error>

Performs the conversion.

impl<T> Eq for Credential<T>

where T: Eq,

impl<T> StructuralPartialEq for Credential<T>