Struct ValidationOptions

pub struct ValidationOptions {
    pub leeway: u64,
    pub validate_exp: bool,
    pub validate_nbf: bool,
    pub audiences: Option<HashSet<String>>,
    pub issuer: Option<String>,
    pub subject: Option<String>,
    pub algorithms: HashSet<Algorithm>,
    pub required_claims: Option<HashSet<String>>,
}

Fields

leeway: u64

General leeway (in seconds) applied to all time-related claims like exp, nbf, and iat.

validate_exp: bool

Validate the expiration time (exp claim).

validate_nbf: bool

Validate the not-before time (nbf claim).

audiences: Option<HashSet<String>>

Set of acceptable audience members.

issuer: Option<String>

Expected issuer.

subject: Option<String>

Expected subject.

algorithms: HashSet<Algorithm>

Allowed signing algorithms for the JWT.

required_claims: Option<HashSet<String>>

Required claims.

Implementations

impl ValidationOptions

pub fn new(alg: Algorithm) -> Self

Create a new set of ValidationOptions with a specific algorithm.

pub fn without_expiry(self) -> Self

Disable expiration (exp) validation.

pub fn with_audiences<T: ToString>(self, audiences: &[T]) -> Self

Set acceptable audience members as a HashSet of strings.

pub fn with_audience<T: ToString>(self, audience: T) -> Self

Set a single audience member as the only acceptable value.

pub fn with_issuer<T: ToString>(self, issuer: T) -> Self

Set the issuer claim to validate.

pub fn with_subject<T: ToString>(self, subject: T) -> Self

Set the subject claim to validate.

pub fn with_leeway(self, leeway: u64) -> Self

Set leeway for time-related claims (exp, nbf, iat).

pub fn with_algorithm(self, alg: Algorithm) -> Self

Add an allowed signing algorithm.

pub fn with_required_claim<T: ToString>(self, claim: T) -> Self

Add a required claim.

Trait Implementations

impl Clone for ValidationOptions

fn clone(&self) -> ValidationOptions

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ValidationOptions

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

Formats the value using the given formatter.

impl Default for ValidationOptions

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for ValidationOptions

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for ValidationOptions