Struct SignedToken

#[non_exhaustive]
pub struct SignedToken<A, T, H = Empty>
where
    A: Algorithm + ?Sized,
{
    pub signature: <A as Algorithm>::Signature,
    pub token: Token<T, H>,
}

Token together with the validated token signature.

Examples

#[derive(Serialize, Deserialize)]
struct MyClaims {
    // Custom claims in the token...
}

let token_string: String = // token from an external source
let token = UntrustedToken::new(&token_string)?;
let signed = Hs256.validator::<MyClaims>(&key)
    .validate_for_signed_token(&token)?;

// `signature` is strongly typed.
let signature: Hs256Signature = signed.signature;
// Token itself is available via `token` field.
let claims = signed.token.claims();
claims.validate_expiration(&TimeOptions::default())?;
// Process the claims...

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

signature: <A as Algorithm>::Signature

Token signature.

token: Token<T, H>

Verified token.

Trait Implementations

impl<A, T, H> Clone for SignedToken<A, T, H>

where A: Algorithm, <A as Algorithm>::Signature: Clone, T: Clone, H: Clone,

fn clone(&self) -> SignedToken<A, T, H>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<A, T, H> Debug for SignedToken<A, T, H>

where A: Algorithm, <A as Algorithm>::Signature: Debug, T: Debug, H: Debug,

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

Formats the value using the given formatter.

impl<A, T, H> Decode for SignedToken<A, T, H>

where A: Algorithm + ?Sized, <A as Algorithm>::Signature: Decode, Token<T, H>: Decode,

fn decode<__CodecInputEdqy>( __codec_input_edqy: &mut __CodecInputEdqy, ) -> Result<SignedToken<A, T, H>, Error>

where __CodecInputEdqy: Input,

Attempt to deserialise the value from input.

fn decode_into<I>( input: &mut I, dst: &mut MaybeUninit<Self>, ) -> Result<DecodeFinished, Error>

where I: Input,

Attempt to deserialize the value from input into a pre-allocated piece of memory.

fn skip<I>(input: &mut I) -> Result<(), Error>

where I: Input,

Attempt to skip the encoded value from input.

fn encoded_fixed_size() -> Option<usize>

Returns the fixed encoded size of the type.

impl<'de, A, T, H> Deserialize<'de> for SignedToken<A, T, H>

where A: Algorithm + ?Sized, T: Deserialize<'de>, H: Deserialize<'de>, <A as Algorithm>::Signature: Deserialize<'de>,

fn deserialize<__D>( __deserializer: __D, ) -> Result<SignedToken<A, T, H>, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<A, T, H> Encode for SignedToken<A, T, H>

where A: Algorithm + ?Sized, <A as Algorithm>::Signature: Encode, Token<T, H>: Encode,

fn size_hint(&self) -> usize

If possible give a hint of expected size of the encoding.

fn encode_to<__CodecOutputEdqy>( &self, __codec_dest_edqy: &mut __CodecOutputEdqy, )

where __CodecOutputEdqy: Output + ?Sized,

Convert self to a slice and append it to the destination.

fn encode(&self) -> Vec<u8>

Convert self to an owned vector.

fn using_encoded<R, F>(&self, f: F) -> R

where F: FnOnce(&[u8]) -> R,

Convert self to a slice and then invoke the given closure with it.

fn encoded_size(&self) -> usize

Calculates the encoded size.

impl<A, T, H> MaxEncodedLen for SignedToken<A, T, H>

where A: Algorithm + ?Sized, <A as Algorithm>::Signature: MaxEncodedLen, Token<T, H>: MaxEncodedLen,

fn max_encoded_len() -> usize

Upper bound, in bytes, of the maximum encoded size of this item.

impl<A, T, H> Serialize for SignedToken<A, T, H>

where A: Algorithm + ?Sized, T: Serialize, H: Serialize, <A as Algorithm>::Signature: Serialize,

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<A, T, H> EncodeLike for SignedToken<A, T, H>

where A: Algorithm + ?Sized, <A as Algorithm>::Signature: Encode, Token<T, H>: Encode,