Struct JwtService 

pub struct JwtService { /* private fields */ }

JWT service struct providing token generation and validation functionality.

Implementations

impl JwtService

pub fn new( config: JwtConfig, encoding_key: EncodingKey, decoding_key: DecodingKey, validation: Validation, ) -> JwtService

Creates a new JwtService instance.

Arguments

• JwtConfig - The JWT configuration.
• EncodingKey - The encoding key for signing tokens.
• DecodingKey - The decoding key for verifying tokens.
• Validation - The validation settings for token verification.

Returns

• JwtService - The created service instance.

pub fn get_config(&self) -> &JwtConfig

Returns a reference to the JWT configuration.

Returns

• &JwtConfig - The configuration.

pub fn get_encoding_key(&self) -> &EncodingKey

Returns a reference to the encoding key.

Returns

• &EncodingKey - The encoding key.

pub fn get_decoding_key(&self) -> &DecodingKey

Returns a reference to the decoding key.

Returns

• &DecodingKey - The decoding key.

pub fn get_validation(&self) -> &Validation

Returns a reference to the validation settings.

Returns

• &Validation - The validation settings.

impl JwtService

Implementation block for JwtService core functionality.

pub fn generate_token<S>(&self, subject: S) -> Result<JwtToken, String>

where S: AsRef<str>,

Generates a JWT token for the given subject.

Arguments

• AsRef<str> - The subject (user identifier) to include in the token.

Returns

• Result<JwtToken, String> - The generated token on success, or an error message on failure.

pub fn validate_token<T>( &self, token: T, ) -> Result<JwtExtraJwtClaims, JwtValidationError>

where T: AsRef<str>,

Validates a JWT token and returns its claims.

Arguments

• AsRef<str> - The JWT token to validate.

Returns

• Result<JwtExtraJwtClaims, JwtValidationError> - The claims on success, or a validation error on failure.

pub fn get_subject_from_token<T>(&self, token: T) -> Result<String, String>

where T: AsRef<str>,

Extracts the subject from a JWT token.

Arguments

• AsRef<str> - The JWT token to extract the subject from.

Returns

• Result<String, String> - The subject on success, or an error message on failure.

pub fn is_token_expired<T>(&self, token: T) -> Result<bool, String>

where T: AsRef<str>,

Checks if a JWT token is expired.

Arguments

• AsRef<str> - The JWT token to check.

Returns

• Result<bool, String> - True if expired, false otherwise, or an error message on failure.

impl JwtService

Implementation block for JwtService with custom claims support.

pub fn generate_token_with_claims<U, S>( &self, subject: S, claims: U, ) -> Result<JwtToken, String>

where U: Clone + Default + Serialize + for<'de> Deserialize<'de>, S: AsRef<str>,

Generates a JWT token with custom claims.

Arguments

• AsRef<str> - The subject (user identifier) to include in the token.
• Clone + Default + Serialize + for<'de> Deserialize<'de> - The custom claims to include in the token payload.

Returns

• Result<JwtToken, String> - The generated token on success, or an error message on failure.

pub fn validate_token_with_claims<U, T>( &self, token: T, ) -> Result<CustomExtraJwtClaims<U>, JwtValidationError>

where U: Clone + Default + Serialize + for<'de> Deserialize<'de>, T: AsRef<str>,

Validates a JWT token and returns its custom claims.

Arguments

• AsRef<str> - The JWT token to validate.

Returns

• Result<CustomExtraJwtClaims<U>, JwtValidationError> - The custom claims on success, or a validation error on failure.

pub fn generate_token_with_extra_claims<S>( &self, subject: S, extra: HashMap<String, Value>, ) -> Result<JwtToken, String>

where S: AsRef<str>,

Generates a JWT token with extra custom fields.

Arguments

• AsRef<str> - The subject (user identifier) to include in the token.
• HashMap<String, Value> - Additional key-value pairs to include in the token payload.

Returns

• Result<JwtToken, String> - The generated token on success, or an error message on failure.

pub fn validate_token_with_extra_claims<T>( &self, token: T, ) -> Result<ExtraJwtClaims, JwtValidationError>

where T: AsRef<str>,

Validates a JWT token and returns its claims with extra fields.

Arguments

• AsRef<str> - The JWT token to validate.

Returns

• Result<ExtraJwtClaims, JwtValidationError> - The claims with extra fields on success, or a validation error on failure.

pub fn get_from_token<T, K>( &self, token: T, field_key: K, ) -> Result<Option<Value>, JwtValidationError>

where T: AsRef<str>, K: AsRef<str>,

Extracts a specific field value from a JWT token’s extra claims.

Arguments

• AsRef<str> - The JWT AsRef<str token to extract the field from.
• AsRef<str> - The key of the field to retrieve.

Returns

• Result<Option<Value>, JwtValidationError> - The field value if found, or None, or a validation error.

Trait Implementations

impl Clone for JwtService

fn clone(&self) -> JwtService

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for JwtService

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

Formats the value using the given formatter.

impl From<JwtConfig> for JwtService

Conversion from JwtConfig to JwtService.

Arguments

• JwtConfig - The JWT configuration to convert.

Returns

• JwtService - The initialized JWT service.

fn from(config: JwtConfig) -> JwtService

Converts to this type from the input type.