Struct aliri_jose::Jwt

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

A JSON Web Token

Implementations

impl Jwt

pub fn new<T: Into<String>>(raw: T) -> Self

Strongly types the given String.

pub fn into_inner(self) -> String

Unwraps the underlying value.

pub fn as_str(&self) -> &str

Provides access to the underlying value as a string slice.

Methods from Deref<Target = 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.

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 Borrow<JwtRef> for Jwt

fn borrow(&self) -> &JwtRef

Immutably borrows from an owned value.

impl Clone for Jwt

fn clone(&self) -> Jwt

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Jwt

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

Formats the value using the given formatter.

impl Deref for Jwt

type Target = JwtRef

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<'de> Deserialize<'de> for Jwt

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

Deserialize this value from the given Serde deserializer.

impl<'a> Display for Jwt

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

Formats the value using the given formatter.

impl Eq for Jwt

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

fn from(kid: &JwtRef) -> Self

Performs the conversion.

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

fn from(kid: &str) -> Self

Performs the conversion.

impl From<Jwt> for String

fn from(wrapper: Jwt) -> Self

Performs the conversion.

impl From<String> for Jwt

fn from(kid: String) -> Self

Performs the conversion.

impl Hash for Jwt

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 Jwt

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

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

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

This method tests for !=.

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 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 Serialize for Jwt

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

Serialize this value into the given Serde serializer.

impl StructuralEq for Jwt

impl StructuralPartialEq for Jwt