Struct aliri_jose::jwt::Claims

pub struct Claims<P = Empty> { /* fields omitted */ }

Common claims used in JWTs

Implementations

impl Claims

pub const fn new() -> Self

Constructs a new, empty payload

impl<C: Serialize> Claims<C>

pub fn sign<H: Serialize + HasAlgorithm>(
    &self,
    jwk: &Jwk,
    headers: &H
) -> Result<Jwt, JwtSigningError>

Produces a signed JWT with the given header and claims

impl<P> Claims<P>

pub fn with_audience(self, aud: impl Into<Audience>) -> Self

Sets the aud claim for the JWT

pub fn with_audiences(self, aud: impl Into<Audiences>) -> Self

Sets the aud claim for the JWT, where multiple audiences are allowed

pub fn with_issuer(self, iss: impl Into<Issuer>) -> Self

Sets the iss claim for the JWT

pub fn with_subject(self, sub: impl Into<Subject>) -> Self

Sets the sub claim for the JWT

pub fn with_future_expiration(self, secs: u64) -> Self

Sets the exp claim for the JWT using the system clock

pub fn with_future_expiration_from_clock<C: Clock>(
    self,
    secs: u64,
    clock: &C
) -> Self

Sets the exp claim for the JWT using the specified clock

pub fn with_expiration(self, time: UnixTime) -> Self

Sets the exp claim for the JWT

pub fn with_not_before(self, time: UnixTime) -> Self

Sets the nbf claim for the JWT

pub fn with_payload<Q>(self, payload: Q) -> Claims<Q>

Adds a custom payload of claims to the JWT

pub fn payload(&self) -> &P

Borrows the custom claims attached to the JWT

pub fn take_payload(self) -> P

Moves the custom claims out

Trait Implementations

impl<P: Clone> Clone for Claims<P>

fn clone(&self) -> Claims<P>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<P> CoreClaims for Claims<P>

fn aud(&self) -> &Audiences

Audience

fn iss(&self) -> Option<&IssuerRef>

Issuer

fn sub(&self) -> Option<&SubjectRef>

Subject

fn exp(&self) -> Option<UnixTime>

Expires

fn nbf(&self) -> Option<UnixTime>

Not before

impl<P: Debug> Debug for Claims<P>

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

Formats the value using the given formatter.

impl<'de, P> Deserialize<'de> for Claims<P> where
    P: Deserialize<'de>, 

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

Deserialize this value from the given Serde deserializer.

impl<P: Eq> Eq for Claims<P>

impl<P: PartialEq> PartialEq<Claims<P>> for Claims<P>

fn eq(&self, other: &Claims<P>) -> bool

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

fn ne(&self, other: &Claims<P>) -> bool

This method tests for !=.

impl<P> Serialize for Claims<P> where
    P: Serialize, 

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

Serialize this value into the given Serde serializer.

impl<P> StructuralEq for Claims<P>

impl<P> StructuralPartialEq for Claims<P>