Struct Claims 

pub struct Claims {
    inner: Map<String, Value>,
}

Represents a set of claims made by a JWT.

Fields

inner: Map<String, Value>

Implementations

impl Claims

pub fn new() -> Self

pub fn check<'s, V: Deserialize<'s>>( self, name: &'static str, expectation: impl FnOnce(&'static str, Option<V>) -> Result<(), Error>, ) -> Result<Self, Error>

Checks that the claim with name meets the given expectation, and removes it from the set. The Deserializer is given ownership of the claim’s contents, so for V you probably want to use an owned type like String instead of &str.

pub fn check_present_and<'s, V: Deserialize<'s>>( self, name: &'static str, expectation: impl FnOnce(&'static str, V) -> Result<(), Error>, ) -> Result<Self, Error>

Check that the claim with name exists and meets the given expectation, removing the claim from the set afterwards. Variation on Claims::check.

pub fn check_no(self, name: &'static str) -> Result<Self, Error>

Checks that there is no claim with name.

pub fn extract<V: DeserializeOwned>( &mut self, name: &'static str, ) -> Result<Option<V>, Error>

Returns the contents of claim with name, if it exists, enabling manual checking.

pub fn ignore(self, name: &'static str) -> Self

Removes named claim from this set, if present, effectively ignoring it.

pub fn check_iss( self, expectation: impl FnOnce(&'static str, Option<String>) -> Result<(), Error>, ) -> Result<Self, Error>

Self::check for iss claim.

pub fn check_sub( self, expectation: impl FnOnce(&'static str, Option<String>) -> Result<(), Error>, ) -> Result<Self, Error>

Self::check for sub claim.

pub fn default_check_timestamps(self) -> Result<Self, Error>

Checks timestamps iat, exp and nbf. When present they should be a valid NumericDate, and the current moment should be between nbf and exp.

pub fn default_check_common_claims(self) -> Result<Self, Error>

Checks and removes iat, exp, and nbf, and makes sure sub and iss have already been checked (i.e. are no longer present).

pub fn visit_custom<C: DeserializeOwned, R>( self, visitor: impl FnOnce(C) -> R, ) -> Result<R, Error>

Deserializes remaining, custom, claims into a type C and calls the given visitor function on it.

Will call Claims::default_check_common_claims first, checking iat, etc..

We can, in general, not return C directly, because C might borrow from the Deserializer.

For the caller’s convenience, we pass along anything that’s returned by the visitor.

Consumes self to prevent deserializing to C twice.

pub fn into_custom<C: DeserializeOwned>(self) -> Result<C, Error>

Like Self::visit_custom, but returns C (which is not possible when C borrows from its Deserializer.)

pub fn from_custom<C: Serialize>(claims: C) -> Result<Self, Error>

Creates new Claims from an object that serializes to a json map.

pub fn claim<V: Serialize>( self, name: &'static str, value: V, ) -> Result<Self, Error>

Adds the named claim with the given value. Returns an error when a claim with the same name was already present.

pub fn iat_now(self) -> Result<Self, Error>

Adds the iat claim using the current timestamp

pub fn exp_after(self, duration: Duration) -> Result<Self, Error>

Sets exp claim such that the jwt is valid for the given duration.

pub fn nbf(self) -> Result<Self, Error>

Sets nbf to the current timestamp, minus 30 seconds leeway.

pub fn sign<SK: SigningKey>(&self, sk: &SK) -> Result<JWT, Error>

Signs these claims, returning a JWT.

Trait Implementations

impl Clone for Claims

fn clone(&self) -> Claims

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Claims

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

Formats the value using the given formatter.

impl Default for Claims

fn default() -> Claims

Returns the “default value” for a type.

impl Serialize for Claims

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

where __S: Serializer,

Serialize this value into the given Serde serializer.