Struct mini_functions::jwt::JWT

pub struct JWT {
    pub header: Header,
    pub claims: Claims,
    pub signature: Vec<u8>,
    pub token: String,
}

JWT is a struct that holds the JWT token and its associated claims. Provides a set of utility functions for working with JSON Web Tokens (JWTs) and JSON Web Signatures (JWSs).

Fields

header: Header

The header of the JWT.

claims: Claims

The claims associated with the JWT.

signature: Vec<u8>

The signature of the JWT.

token: String

The JWT token.

Implementations

impl JWT

pub fn claims() -> Claims

Claims returns a default Claims struct.

pub fn decode(&mut self, secret: &[u8]) -> Result<String, JwtError>

Decodes a JWT token. takes a mutable reference to a JWT struct and a reference to a slice of bytes representing a secret, and it returns a Result containing a string or an Error variant. The function splits the JWT stored in the token field of the JWT struct into its header, claims, and signature, decodes the header and claims from base64, deserializes the header and claims from JSON, and then verifies the JWT’s signature using the provided secret.

Arguments

• secret - A byte array containing the secret used to sign the JWT.

Returns

• Ok(String) - The decoded JWT as a string.
• Err(Error) - An error if the JWT is invalid or if there was a problem decoding it.

pub fn encode( header: Header, claims: Claims, secret: &[u8] ) -> Result<String, JwtError>

Encodes a JWT token using the provided header, claims, and secret. It returns a Result containing a string or an Error variant. The function serializes the header and claims to JSON, base64-encodes the header and claims, concatenates the encoded header, claims, and separators, and then signs the JWT with the provided secret.

pub fn generate(secret: &[u8]) -> Result<String, JwtError>

Generates a JWT token.

pub fn get_token(jwt: JWT) -> String

Returns the token field of the JWT struct.

pub fn get_token_header(jwt: JWT) -> Header

Returns the header field of the JWT struct.

pub fn get_token_length(jwt: JWT) -> usize

Get the token length.

pub fn validate(&self, secret: &[u8]) -> Result<(), JwtError>

Validates a JWT token.

Trait Implementations

impl Clone for JWT

fn clone(&self) -> JWT

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for JWT

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

Formats the value using the given formatter.

impl Default for JWT

fn default() -> JWT

Returns a default JWT struct.

impl<'de> Deserialize<'de> for JWT

fn deserialize<__D>( __deserializer: __D ) -> Result<JWT, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for JWT

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

Formats the JWT struct for printing.

impl Serialize for JWT

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.