Struct openidconnect::IdToken

source · [−]

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

Expand description

OpenID Connect ID token.

Implementations

source

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,

source

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.

source

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

Verifies and returns a reference to the ID token claims.

source

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

Verifies and returns the ID token claims.

source

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

source

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>

source

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

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

source

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

Formats the value using the given formatter. Read more

source

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,

source

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

Deserialize this value from the given Serde deserializer. Read more

source

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

type Err = Error

The associated error which can be returned from parsing.

source

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type. Read more

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>

source

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

source

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

This method tests for !=.

source

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

source

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

Serialize this value into the given Serde serializer. Read more

source

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,

source

fn to_string(&self) -> String

Converts the given value to a String. Read more

source

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

Auto Trait Implementations

impl<AC, GC, JE, JS, JT> RefUnwindSafe for IdToken<AC, GC, JE, JS, JT> where
 AC: RefUnwindSafe,
 GC: RefUnwindSafe,
 JE: RefUnwindSafe,
 JS: RefUnwindSafe,
 JT: RefUnwindSafe,

impl<AC, GC, JE, JS, JT> Send for IdToken<AC, GC, JE, JS, JT> where
 AC: Send,
 GC: Send,
 JE: Send,
 JS: Send,
 JT: Send,

impl<AC, GC, JE, JS, JT> Sync for IdToken<AC, GC, JE, JS, JT> where
 AC: Sync,
 GC: Sync,
 JE: Sync,
 JS: Sync,
 JT: Sync,

impl<AC, GC, JE, JS, JT> Unpin for IdToken<AC, GC, JE, JS, JT> where
 AC: Unpin,
 GC: Unpin,
 JE: Unpin,
 JS: Unpin,
 JT: Unpin,

impl<AC, GC, JE, JS, JT> UnwindSafe for IdToken<AC, GC, JE, JS, JT> where
 AC: UnwindSafe,
 GC: UnwindSafe,
 JE: UnwindSafe,
 JS: UnwindSafe,
 JT: 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> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

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> 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, 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 openidconnect::IdToken

Implementations

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

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

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

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

Trait Implementations

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>

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

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

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

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

type Err = Error

fn from_str(s: &str) -> Result<Self, Self::Err>

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

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

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,

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

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

Auto Trait Implementations

impl<AC, GC, JE, JS, JT> RefUnwindSafe for IdToken<AC, GC, JE, JS, JT> where AC: RefUnwindSafe, GC: RefUnwindSafe, JE: RefUnwindSafe, JS: RefUnwindSafe, JT: RefUnwindSafe,

impl<AC, GC, JE, JS, JT> Send for IdToken<AC, GC, JE, JS, JT> where AC: Send, GC: Send, JE: Send, JS: Send, JT: Send,

impl<AC, GC, JE, JS, JT> Sync for IdToken<AC, GC, JE, JS, JT> where AC: Sync, GC: Sync, JE: Sync, JS: Sync, JT: Sync,

impl<AC, GC, JE, JS, JT> Unpin for IdToken<AC, GC, JE, JS, JT> where AC: Unpin, GC: Unpin, JE: Unpin, JS: Unpin, JT: Unpin,

impl<AC, GC, JE, JS, JT> UnwindSafe for IdToken<AC, GC, JE, JS, JT> where AC: UnwindSafe, GC: UnwindSafe, JE: UnwindSafe, JS: UnwindSafe, JT: 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> From<T> for T

fn from(t: T) -> T

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> ToOwned for T where T: Clone,

type Owned = T

fn to_owned(&self) -> T

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

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>

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

type Error = <U as TryFrom<T>>::Error

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

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

fn vzip(self) -> V

impl<T> WithSubscriber for T

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

fn with_current_subscriber(self) -> WithDispatch<Self>

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

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

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

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

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

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

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,

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,

impl<AC, GC, JE, JS, JT> RefUnwindSafe for IdToken<AC, GC, JE, JS, JT> where
AC: RefUnwindSafe,
GC: RefUnwindSafe,
JE: RefUnwindSafe,
JS: RefUnwindSafe,
JT: RefUnwindSafe,

impl<AC, GC, JE, JS, JT> Send for IdToken<AC, GC, JE, JS, JT> where
AC: Send,
GC: Send,
JE: Send,
JS: Send,
JT: Send,

impl<AC, GC, JE, JS, JT> Sync for IdToken<AC, GC, JE, JS, JT> where
AC: Sync,
GC: Sync,
JE: Sync,
JS: Sync,
JT: Sync,

impl<AC, GC, JE, JS, JT> Unpin for IdToken<AC, GC, JE, JS, JT> where
AC: Unpin,
GC: Unpin,
JE: Unpin,
JS: Unpin,
JT: Unpin,

impl<AC, GC, JE, JS, JT> UnwindSafe for IdToken<AC, GC, JE, JS, JT> where
AC: UnwindSafe,
GC: UnwindSafe,
JE: UnwindSafe,
JS: UnwindSafe,
JT: 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, U> Into<U> for T where
U: From<T>,

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

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