Struct identity_iota::credential::Credential

source · [−]

pub struct Credential<T = BTreeMap<String, Value, Global>> {Show 15 fields
    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<BTreeMap<String, Value, Global>>>,
    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>,
}

Expand description

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<BTreeMap<String, Value, Global>>>

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>

Proof(s) used to verify a Credential

Implementations

source

impl<T> Credential<T>

source

pub fn base_context() -> &'static Context

Returns the base JSON-LD context.

source

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

Returns the base type.

source

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

Creates a new CredentialBuilder to configure a Credential.

This is the same as CredentialBuilder::new.

source

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

Returns a new Credential based on the CredentialBuilder configuration.

source

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

Validates the semantic structure of the Credential.

source

pub fn proof(&self) -> Option<&Proof>

Returns a reference to the proof.

source

pub fn proof_mut(&mut self) -> Option<&mut Proof>

Returns a mutable reference to the proof.

Trait Implementations

source

impl<T> Clone for Credential<T> where
T: Clone,

source

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

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

source

impl<T> Debug for Credential<T> where
T: Debug,

source

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

Formats the value using the given formatter. Read more

source

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

source

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. Read more

source

impl<T> Display for Credential<T> where
T: Serialize,

source

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

Formats the value using the given formatter. Read more

source

impl<T> GetSignature for Credential<T>

source

fn signature(&self) -> Option<&Proof>

Returns a reference to the Proof object, if any.

source

impl<T> GetSignatureMut for Credential<T>

source

fn signature_mut(&mut self) -> Option<&mut Proof>

Returns a mutable reference to the Proof object, if any.

source

impl<T> PartialEq<Credential<T>> for Credential<T> where
T: PartialEq<T>,

source

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

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

source

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

This method tests for !=.

source

impl<T> Serialize for Credential<T> where
T: Serialize,

source

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. Read more

source

impl<T> SetSignature for Credential<T>

source

fn set_signature(&mut self, value: Proof)

Sets the Proof object of self.

source

impl<T> TryMethod for Credential<T>

source

const TYPE: MethodUriType = MethodUriType::Absolute

Flag that determines whether absolute or rleative URI

source

fn method<D, U>(method: &VerificationMethod<D, U>) -> Option<String> where
D: DID,

Returns an absolute or relative method URI, if any, depending on the MethodUriType. Read more

source

fn try_method<D, U>(method: &VerificationMethod<D, U>) -> Result<String, Error> where
D: DID,

Returns String representation of absolute or relative method URI. Read more

source

impl<T> StructuralPartialEq for Credential<T>

Auto Trait Implementations

impl<T> RefUnwindSafe for Credential<T> where
T: RefUnwindSafe,

impl<T> Send for Credential<T> where
T: Send,

impl<T> Sync for Credential<T> where
T: Sync,

impl<T> Unpin for Credential<T> where
T: Unpin,

impl<T> UnwindSafe for Credential<T> where
T: UnwindSafe,

Blanket Implementations

source

impl<T> Any for T where
T: 'static + ?Sized,

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<T> FmtJson for T where
T: ToJson,

source

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

Format this as a JSON string or pretty-JSON string based on whether the # format flag was used. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T> FromJson for T where
T: for<'de> Deserialize<'de>,

source

fn from_json(json: &impl AsRef<str>) -> Result<Self, Error>

Deserialize Self from a string of JSON text.

source

fn from_json_slice(json: &impl AsRef<[u8]>) -> Result<Self, Error>

Deserialize Self from bytes of JSON text.

source

fn from_json_value(json: Value) -> Result<Self, Error>

Deserialize Self from a [serde_json::Value].

source

impl<T> Instrument for T

source

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

source

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

source

impl<T, U> Into for T where
U: From<T>,

const: unstable · source

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source

impl<T> Same<T> for T

type Output = T

Should always be Self

source

impl<T> ToJson for T where
T: Serialize,

source

fn to_json(&self) -> Result<String, Error>

Serialize self as a string of JSON.

source

fn to_json_vec(&self) -> Result<Vec<u8, Global>, Error>

Serialize self as a JSON byte vector.

source

fn to_json_value(&self) -> Result<Value, Error>

Serialize self as a [serde_json::Value].

source

fn to_json_pretty(&self) -> Result<String, Error>

Serialize self as a pretty-printed string of JSON.

source

fn to_jcs(&self) -> Result<Vec<u8, Global>, Error>

Serialize self as a JSON byte vector, normalized using JSON Canonicalization Scheme (JCS). Read more

source

impl<T> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

source

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

source

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

source

impl<T> ToString for T where
T: Display + ?Sized,

source

default fn to_string(&self) -> String

Converts the given value to a String. Read more

source

impl<T, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

impl<V, T> VZip<V> for T where
V: MultiLane<T>,

fn vzip(self) -> V

source

impl<T> WithSubscriber for T

source

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

source

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more

source

Struct identity_iota::credential::Credential

Fields

Implementations

impl<T> Credential<T>

pub fn base_context() -> &'static Context

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

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

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

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

pub fn proof(&self) -> Option<&Proof>

pub fn proof_mut(&mut self) -> Option<&mut Proof>

Trait Implementations

impl<T> Clone for Credential<T> where T: Clone,

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

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

impl<T> Debug for Credential<T> where T: Debug,

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

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>,

impl<T> Display for Credential<T> where T: Serialize,

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

impl<T> GetSignature for Credential<T>

fn signature(&self) -> Option<&Proof>

impl<T> GetSignatureMut for Credential<T>

fn signature_mut(&mut self) -> Option<&mut Proof>

impl<T> PartialEq<Credential<T>> for Credential<T> where T: PartialEq<T>,

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

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

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,

impl<T> SetSignature for Credential<T>

fn set_signature(&mut self, value: Proof)

impl<T> TryMethod for Credential<T>

const TYPE: MethodUriType = MethodUriType::Absolute

fn method<D, U>(method: &VerificationMethod<D, U>) -> Option<String> where D: DID,

fn try_method<D, U>(method: &VerificationMethod<D, U>) -> Result<String, Error> where D: DID,

impl<T> StructuralPartialEq for Credential<T>

Auto Trait Implementations

impl<T> RefUnwindSafe for Credential<T> where T: RefUnwindSafe,

impl<T> Send for Credential<T> where T: Send,

impl<T> Sync for Credential<T> where T: Sync,

impl<T> Unpin for Credential<T> where T: Unpin,

impl<T> UnwindSafe for Credential<T> where T: UnwindSafe,

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> FmtJson for T where T: ToJson,

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

impl<T> From<T> for T

fn from(t: T) -> T

impl<T> FromJson for T where T: for<'de> Deserialize<'de>,

fn from_json(json: &impl AsRef<str>) -> Result<Self, Error>

fn from_json_slice(json: &impl AsRef<[u8]>) -> Result<Self, Error>

fn from_json_value(json: Value) -> Result<Self, Error>

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

fn in_current_span(self) -> Instrumented<Self>

impl<T, U> Into<U> for T where U: From<T>,

fn into(self) -> U

impl<T> Same<T> for T

type Output = T

impl<T> ToJson for T where T: Serialize,

fn to_json(&self) -> Result<String, Error>

fn to_json_vec(&self) -> Result<Vec<u8, Global>, Error>

fn to_json_value(&self) -> Result<Value, Error>

fn to_json_pretty(&self) -> Result<String, Error>

fn to_jcs(&self) -> Result<Vec<u8, Global>, Error>

impl<T> ToOwned for T where T: Clone,

type Owned = T

fn to_owned(&self) -> T

fn clone_into(&self, target: &mut T)

impl<T> ToString for T where T: Display + ?Sized,

default fn to_string(&self) -> String

impl<T, U> TryFrom<U> for T where U: Into<T>,

type Error = Infallible

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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

impl<T> Clone for Credential<T> where
T: Clone,

impl<T> Debug for Credential<T> where
T: Debug,

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>,

impl<T> Display for Credential<T> where
T: Serialize,

impl<T> PartialEq<Credential<T>> for Credential<T> where
T: PartialEq<T>,

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,

fn method<D, U>(method: &VerificationMethod<D, U>) -> Option<String> where
D: DID,

fn try_method<D, U>(method: &VerificationMethod<D, U>) -> Result<String, Error> where
D: DID,

impl<T> RefUnwindSafe for Credential<T> where
T: RefUnwindSafe,

impl<T> Send for Credential<T> where
T: Send,

impl<T> Sync for Credential<T> where
T: Sync,

impl<T> Unpin for Credential<T> where
T: Unpin,

impl<T> UnwindSafe for Credential<T> where
T: UnwindSafe,

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<T> FmtJson for T where
T: ToJson,

impl<T> FromJson for T where
T: for<'de> Deserialize<'de>,

impl<T, U> Into<U> for T where
U: From<T>,

impl<T> ToJson for T where
T: Serialize,

impl<T> ToOwned for T where
T: Clone,

impl<T> ToString for T where
T: Display + ?Sized,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

impl<V, T> VZip<V> for T where
V: MultiLane<T>,

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,

impl<T> DeserializeOwned for T where
T: for<'de> Deserialize<'de>,