Struct ExtraJwtClaims 

pub struct ExtraJwtClaims { /* private fields */ }

Extended JWT claims struct with support for custom extra fields.

Implementations

impl ExtraJwtClaims

pub fn new<S>(sub: S, iss: S, exp: usize) -> Self

where S: AsRef<str>,

Creates a new ExtraJwtClaims instance.

Arguments

• AsRef<str> - The subject (user identifier).
• AsRef<str> - The issuer.
• usize - Expiration time as a Unix timestamp.

Returns

• ExtraJwtClaims - The created claims instance.

pub fn get_sub(&self) -> &String

Returns a reference to the subject.

Returns

• &String - The subject.

pub fn set_sub<S>(&mut self, sub: S) -> &mut Self

where S: AsRef<str>,

Sets the subject.

Arguments

• AsRef<str> - The subject to set.

Returns

• &mut Self - The modified instance for chaining.

pub fn get_iss(&self) -> &String

Returns a reference to the issuer.

Returns

• &String - The issuer.

pub fn set_iss<S>(&mut self, iss: S) -> &mut Self

where S: AsRef<str>,

Sets the issuer.

Arguments

• AsRef<str> - The issuer to set.

Returns

• &mut Self - The modified instance for chaining.

pub fn get_exp(&self) -> usize

Returns the expiration time.

Returns

• usize - The expiration timestamp.

pub fn set_exp(&mut self, exp: usize) -> &mut Self

Sets the expiration time.

Arguments

• exp - The expiration timestamp to set.

Returns

• &mut Self - The modified instance for chaining.

pub fn get_iat(&self) -> usize

Returns the issued at time.

Returns

• usize - The issued at timestamp.

pub fn set_iat(&mut self, iat: usize) -> &mut Self

Sets the issued at time.

Arguments

• usize - The issued at timestamp to set.

Returns

• &mut Self - The modified instance for chaining.

pub fn get_extra(&self) -> &HashMap<String, Value>

Returns a reference to the extra claims.

Returns

• &HashMap<String, Value> - The extra claims.

pub fn get_mut_extra(&mut self) -> &mut HashMap<String, Value>

Returns a mutable reference to the extra claims.

Returns

• &mut HashMap<String, Value> - The mutable extra claims.

pub fn set_extra(&mut self, extra: HashMap<String, Value>) -> &mut Self

Sets the extra claims.

Arguments

• HashMap<String, Value> - The extra claims to set.

Returns

• &mut Self - The modified instance for chaining.

impl ExtraJwtClaims

Implementation block for ExtraJwtClaims helper methods.

pub fn insert(self, key: String, value: Value) -> Self

Inserts a key-value pair into the extra claims.

Arguments

• String - The key to insert.
• Value - The value to associate with the key.

Returns

• Self - The modified ExtraJwtClaims instance for chaining.

pub fn extend_extra(self, extra: HashMap<String, Value>) -> Self

Extends the extra claims with additional key-value pairs.

Arguments

• HashMap<String, Value> - A HashMap of key-value pairs to add.

Returns

• Self - The modified ExtraJwtClaims instance for chaining.

pub fn get<K>(&self, key: K) -> Option<&Value>

where K: AsRef<str>,

Retrieves a value from the extra claims by key.

Arguments

• AsRef<str> - The key to look up.

Returns

• Option<&Value> - The value if found, or None.

pub fn contains_key<K>(&self, key: K) -> bool

where K: AsRef<str>,

Checks if a key exists in the extra claims.

Arguments

• AsRef<str> - The key to check.

Returns

• bool - True if the key exists, false otherwise.

pub fn remove<K>(&mut self, key: K) -> Option<Value>

where K: AsRef<str>,

Removes a key from the extra claims and returns its value.

Arguments

• AsRef<str> - The key to remove.

Returns

• Option<Value> - The removed value if found, or None.

Trait Implementations

impl Clone for ExtraJwtClaims

fn clone(&self) -> ExtraJwtClaims

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ExtraJwtClaims

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

Formats the value using the given formatter.

impl Default for ExtraJwtClaims

fn default() -> ExtraJwtClaims

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ExtraJwtClaims

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for ExtraJwtClaims

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

where __S: Serializer,

Serialize this value into the given Serde serializer.