Struct aliri_jose::JwtRef

#[repr(transparent)]pub struct JwtRef(_);

Reference to a JSON Web Token

Implementations

impl JwtRef

pub fn decompose<H>(&self) -> Result<Decomposed<H>, JwtVerifyError> where
    H: for<'de> Deserialize<'de>, 

Decomposes the JWT into its parts, preparing it for later processing.

pub fn verify<C, H, V>(
    &self,
    key: &V,
    validator: &CoreValidator
) -> Result<Validated<C, H>, JwtVerifyError> where
    C: for<'de> Deserialize<'de>,
    H: for<'de> Deserialize<'de>,
    V: Verifier<Algorithm = Algorithm>,
    JwtVerifyError: From<V::Error>, 

Verifies a token against a particular JWK and validation plan

If you need to inspect the token first to determine how to verify the token, use decompose() to peek into the JWT.

pub fn verify_with_custom<C, H, V, X>(
    &self,
    key: &V,
    validator: &CoreValidator,
    custom: X
) -> Result<Validated<C, H>, JwtVerifyError> where
    C: for<'de> Deserialize<'de>,
    H: for<'de> Deserialize<'de>,
    V: Verifier<Algorithm = Algorithm>,
    JwtVerifyError: From<V::Error>,
    X: ClaimsValidator<C, H>, 

Verifies a token against a particular JWK and validation plan

If you need to inspect the token first to determine how to verify the token, use decompose() to peek into the JWT.

impl JwtRef

pub fn from_str(raw: &str) -> &Self

Transparently reinterprets the string slice as a strongly-typed value.

pub const fn as_str(&self) -> &str

Provides access to the underlying value as a string slice.

Trait Implementations

impl AsRef<JwtRef> for Jwt

fn as_ref(&self) -> &JwtRef

Performs the conversion.

impl AsRef<JwtRef> for JwtRef

fn as_ref(&self) -> &JwtRef

Performs the conversion.

impl Borrow<JwtRef> for Jwt

fn borrow(&self) -> &JwtRef

Immutably borrows from an owned value.

impl Debug for JwtRef

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

Formats the value using the given formatter.

impl<'de: 'a, 'a> Deserialize<'de> for &'a JwtRef

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

Deserialize this value from the given Serde deserializer.

impl<'a> Display for &'a JwtRef

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

Formats the value using the given formatter.

impl Eq for JwtRef

impl<'_> From<&'_ JwtRef> for Jwt

fn from(kid: &JwtRef) -> Self

Performs the conversion.

impl Hash for JwtRef

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].

impl PartialEq<Jwt> for JwtRef

fn eq(&self, other: &Jwt) -> bool

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

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PartialEq<JwtRef> for JwtRef

fn eq(&self, other: &JwtRef) -> bool

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

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

This method tests for !=.

impl PartialEq<JwtRef> for Jwt

fn eq(&self, other: &JwtRef) -> bool

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

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<'a> Serialize for &'a JwtRef

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

Serialize this value into the given Serde serializer.

impl StructuralEq for JwtRef

impl StructuralPartialEq for JwtRef

impl ToOwned for JwtRef

type Owned = Jwt

The resulting type after obtaining ownership.

fn to_owned(&self) -> Self::Owned

Creates owned data from borrowed data, usually by cloning.

fn clone_into(&self, target: &mut Self::Owned)

🔬 This is a nightly-only experimental API. (toowned_clone_into)

recently added

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