[−][src]Struct jwt_compact::Claims
Claims encoded in a token.
Claims are comprised of a "standard" part (exp
, nbf
and iat
claims as per JWT spec),
and custom fields. iss
, sub
and aud
claims are not in the standard part
due to a variety of data types they can be reasonably represented by.
Fields (Non-exhaustive)
Struct { .. }
syntax; cannot be matched against without a wildcard ..
; and struct update syntax will not work.expiration_date: Option<DateTime<Utc>>
Expiration date of the token.
not_before: Option<DateTime<Utc>>
Minimum date at which token is valid.
issued_at: Option<DateTime<Utc>>
Date of token issuance.
custom: T
Custom claims.
Implementations
impl Claims<Empty>
[src]
impl<T> Claims<T>
[src]
pub fn new(custom_claims: T) -> Self
[src]
Creates a new instance with the provided custom claims.
pub fn set_duration<F>(
self,
options: &TimeOptions<F>,
duration: Duration
) -> Self where
F: Fn() -> DateTime<Utc>,
[src]
self,
options: &TimeOptions<F>,
duration: Duration
) -> Self where
F: Fn() -> DateTime<Utc>,
Sets expiration_date
claim so that the token has the specified duration
.
The current timestamp is taken from options
.
pub fn set_duration_and_issuance<F>(
self,
options: &TimeOptions<F>,
duration: Duration
) -> Self where
F: Fn() -> DateTime<Utc>,
[src]
self,
options: &TimeOptions<F>,
duration: Duration
) -> Self where
F: Fn() -> DateTime<Utc>,
Atomically sets issued_at
and expiration_date
claims: first to the current time
(taken from options
), and the second to match the specified duration
of the token.
pub fn set_not_before(self, moment: DateTime<Utc>) -> Self
[src]
Sets the nbf
claim.
pub fn validate_expiration<F>(
&self,
options: &TimeOptions<F>
) -> Result<&Self, ValidationError> where
F: Fn() -> DateTime<Utc>,
[src]
&self,
options: &TimeOptions<F>
) -> Result<&Self, ValidationError> where
F: Fn() -> DateTime<Utc>,
Validates the expiration claim.
This method will return an error if the claims do not feature an expiration date,
or if it is in the past (subject to the provided options
).
pub fn validate_maturity<F>(
&self,
options: &TimeOptions<F>
) -> Result<&Self, ValidationError> where
F: Fn() -> DateTime<Utc>,
[src]
&self,
options: &TimeOptions<F>
) -> Result<&Self, ValidationError> where
F: Fn() -> DateTime<Utc>,
Validates the maturity date (nbf
claim).
This method will return an error if the claims do not feature a maturity date,
or if it is in the future (subject to the provided options
).
Trait Implementations
impl<T: Clone> Clone for Claims<T>
[src]
impl<T: Debug> Debug for Claims<T>
[src]
impl<'de, T> Deserialize<'de> for Claims<T> where
T: Deserialize<'de>,
[src]
T: Deserialize<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
[src]
__D: Deserializer<'de>,
impl<T: PartialEq> PartialEq<Claims<T>> for Claims<T>
[src]
impl<T> Serialize for Claims<T> where
T: Serialize,
[src]
T: Serialize,
fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
__S: Serializer,
[src]
__S: Serializer,
impl<T> StructuralPartialEq for Claims<T>
[src]
Auto Trait Implementations
impl<T> RefUnwindSafe for Claims<T> where
T: RefUnwindSafe,
T: RefUnwindSafe,
impl<T> Send for Claims<T> where
T: Send,
T: Send,
impl<T> Sync for Claims<T> where
T: Sync,
T: Sync,
impl<T> Unpin for Claims<T> where
T: Unpin,
T: Unpin,
impl<T> UnwindSafe for Claims<T> where
T: UnwindSafe,
T: UnwindSafe,
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
pub fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> DeserializeOwned for T where
T: for<'de> Deserialize<'de>,
[src]
T: for<'de> Deserialize<'de>,
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> Same<T> for T
type Output = T
Should always be Self
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
pub fn to_owned(&self) -> T
[src]
pub fn clone_into(&self, target: &mut T)
[src]
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
[src]
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
V: MultiLane<T>,