Struct openidconnect::IdToken

pub struct IdToken<AC: AdditionalClaims, GC: GenderClaim, JE: JweContentEncryptionAlgorithm<JT>, JS: JwsSigningAlgorithm<JT>, JT: JsonWebKeyType>(_);

OpenID Connect ID token.

Methods

impl<AC, GC, JE, JS, JT> IdToken<AC, GC, JE, JS, JT> where
    AC: AdditionalClaims,
    GC: GenderClaim,
    JE: JweContentEncryptionAlgorithm<JT>,
    JS: JwsSigningAlgorithm<JT>,
    JT: JsonWebKeyType, 

pub fn new<JU, K, S>(
    claims: IdTokenClaims<AC, GC>,
    signing_key: &S,
    alg: JS,
    access_token: Option<&AccessToken>,
    code: Option<&AuthorizationCode>
) -> Result<Self, JsonWebTokenError> where
    JU: JsonWebKeyUse,
    K: JsonWebKey<JS, JT, JU>,
    S: PrivateSigningKey<JS, JT, JU, K>, 

Initializes an ID token with the specified claims, signed using the given signing key and algorithm.

If an access_token and/or code are provided, this method sets the at_hash and/or c_hash claims using the given signing algorithm, respectively. Otherwise, those claims are unchanged from the values specified in claims.

pub fn claims<'a, 'b, JU, K, N>(
    &'a self,
    verifier: &'b IdTokenVerifier<JS, JT, JU, K>,
    nonce_verifier: N
) -> Result<&'a IdTokenClaims<AC, GC>, ClaimsVerificationError> where
    JU: JsonWebKeyUse,
    K: JsonWebKey<JS, JT, JU>,
    N: NonceVerifier<'a>, 

Verifies and returns the ID token claims.

pub fn signing_alg(&self) -> Result<JS, SigningError>

Returns the JwsSigningAlgorithm used to sign this ID token.

This function returns an error if the signing algorithm is unsupported.

Trait Implementations

impl<AC, GC, JE, JS, JT> ToString for IdToken<AC, GC, JE, JS, JT> where
    AC: AdditionalClaims,
    GC: GenderClaim,
    JE: JweContentEncryptionAlgorithm<JT>,
    JS: JwsSigningAlgorithm<JT>,
    JT: JsonWebKeyType, 

fn to_string(&self) -> String

Converts the given value to a String.

impl<AC: Clone + AdditionalClaims, GC: Clone + GenderClaim, JE: Clone + JweContentEncryptionAlgorithm<JT>, JS: Clone + JwsSigningAlgorithm<JT>, JT: Clone + JsonWebKeyType> Clone for IdToken<AC, GC, JE, JS, JT>

fn clone(&self) -> IdToken<AC, GC, JE, JS, JT>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<AC: PartialEq + AdditionalClaims, GC: PartialEq + GenderClaim, JE: PartialEq + JweContentEncryptionAlgorithm<JT>, JS: PartialEq + JwsSigningAlgorithm<JT>, JT: PartialEq + JsonWebKeyType> PartialEq<IdToken<AC, GC, JE, JS, JT>> for IdToken<AC, GC, JE, JS, JT>

fn eq(&self, other: &IdToken<AC, GC, JE, JS, JT>) -> bool

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

fn ne(&self, other: &IdToken<AC, GC, JE, JS, JT>) -> bool

This method tests for !=.

impl<AC: Debug + AdditionalClaims, GC: Debug + GenderClaim, JE: Debug + JweContentEncryptionAlgorithm<JT>, JS: Debug + JwsSigningAlgorithm<JT>, JT: Debug + JsonWebKeyType> Debug for IdToken<AC, GC, JE, JS, JT>

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

Formats the value using the given formatter.

impl<AC: AdditionalClaims, GC: GenderClaim, JE: JweContentEncryptionAlgorithm<JT>, JS: JwsSigningAlgorithm<JT>, JT: JsonWebKeyType> Serialize for IdToken<AC, GC, JE, JS, JT> where
    AC: AdditionalClaims, 

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

Serialize this value into the given Serde serializer.

impl<'de, AC: AdditionalClaims, GC: GenderClaim, JE: JweContentEncryptionAlgorithm<JT>, JS: JwsSigningAlgorithm<JT>, JT: JsonWebKeyType> Deserialize<'de> for IdToken<AC, GC, JE, JS, JT> where
    AC: AdditionalClaims, 

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.