Struct JwtClaims

pub struct JwtClaims<T = Map>(/* private fields */);

Available on crate feature jwt only.

JWT Claims.

Implementations

impl<T: Default + Serialize + DeserializeOwned> JwtClaims<T>

pub fn new(subject: impl ToString) -> Self

Creates a new instance with the default data and max-age.

pub fn with_data(subject: impl ToString, data: T) -> Self

Creates a new instance with the custom data.

pub fn with_max_age(subject: impl ToString, max_age: Duration) -> Self

Creates a new instance, expiring in max-age.

pub fn refresh_token(&self) -> Result<String, Error>

Generates an access token signed with the shared secret access key.

pub fn access_token(self) -> Result<String, Error>

Generates an access token signed with the shared secret access key.

pub fn sign_with<K: MACLike>(self, key: &K) -> Result<String, Error>

Generates a signature with the secret access key.

impl<T> JwtClaims<T>

pub fn set_issuer(&mut self, issuer: impl ToString)

Sets the issuer.

pub fn set_audience(&mut self, audience: impl ToString)

Sets the audience.

pub fn set_jwt_id(&mut self, jwt_id: impl ToString)

Sets the JWT identifier.

pub fn set_nonce(&mut self, nonce: impl ToString)

Sets the nonce.

pub fn set_data(&mut self, data: T)

Sets the custom data.

pub fn issued_at(&self) -> DateTime

Returns the time the claims were created at.

pub fn expires_at(&self) -> DateTime

Returns the time the claims expire at.

pub fn expires_in(&self) -> Duration

Returns the time when the claims will expire in.

pub fn subject(&self) -> Option<&str>

Returns the subject.

pub fn nonce(&self) -> Option<&str>

Returns the nonce.

pub fn data(&self) -> &T

Returns the custom data.

impl JwtClaims<Map>

pub fn add_data_entry( &mut self, key: impl Into<String>, value: impl Into<JsonValue>, )

Adds a key-value pair to the custom data.

pub fn bearer_auth(self) -> Result<Map, Error>

Returns the Bearer auth as a JSON object.

impl JwtClaims<()>

pub fn shared_key() -> &'static JwtHmacKey

Returns the shared secret access key for the HMAC algorithm.

Trait Implementations

impl<T: Clone> Clone for JwtClaims<T>

fn clone(&self) -> JwtClaims<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for JwtClaims<T>

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

Formats the value using the given formatter.

impl<T> From<JWTClaims<T>> for JwtClaims<T>

fn from(claims: JWTClaims<T>) -> Self

Converts to this type from the input type.