Struct ParsedToken 

pub struct ParsedToken { /* private fields */ }

Parsed token structure for inspection without cryptographic operations

This struct allows you to examine token metadata (purpose, version, footer) without performing expensive cryptographic verification or decryption. Useful for debugging, logging, middleware, and routing decisions.

Example

use paseto_pq::ParsedToken;

let token = "paseto.pq1.public.ABC123...";
let parsed = ParsedToken::parse(token)?;

println!("Purpose: {}", parsed.purpose()); // "public"
println!("Version: {}", parsed.version()); // "pq1"
println!("Has footer: {}", parsed.has_footer());

// Use for routing decisions
match parsed.purpose() {
    "public" => println!("Public token - needs verification"),
    "local" => println!("Local token - needs decryption"),
    _ => println!("Unsupported token type"),
}

Implementations

impl ParsedToken

pub fn parse(token: &str) -> Result<Self, PqPasetoError>

Parse a PASETO token string to extract structural information

This method performs no cryptographic operations - it only parses the token structure to extract metadata. Use this for debugging, logging, middleware, and routing decisions.

Arguments

• token - The PASETO token string to parse

Returns

Returns a ParsedToken containing the token’s structural information, or an error if the token format is invalid.

Example

use paseto_pq::ParsedToken;

let token = "paseto.pq1.public.ABC123.DEF456.eyJraWQiOiJ0ZXN0In0";
let parsed = ParsedToken::parse(token)?;

assert_eq!(parsed.purpose(), "public");
assert_eq!(parsed.version(), "pq1");
assert!(parsed.has_footer());

pub fn purpose(&self) -> &str

Get the token purpose (“public” for public tokens, “local” for local tokens)

pub fn version(&self) -> &str

Get the token version (currently “pq1”)

pub fn has_footer(&self) -> bool

Check if the token has a footer

pub fn footer(&self) -> Option<&Footer>

Get the footer, if present

pub fn payload_bytes(&self) -> &[u8]

Get the raw payload bytes (base64-decoded)

pub fn signature_bytes(&self) -> Option<&[u8]>

Get the signature or authentication tag bytes, if present

For public tokens, this is the ML-DSA signature. For local tokens, this is None (auth tag is embedded in payload).

pub fn payload_length(&self) -> usize

Get the length of the payload in bytes

pub fn total_length(&self) -> usize

Get the total length of the token string

pub fn raw_token(&self) -> &str

Get the raw token string

pub fn footer_json(&self) -> Option<Result<String, Error>>

Get footer as JSON string, if present

pub fn footer_json_pretty(&self) -> Option<Result<String, Error>>

Get footer as pretty-printed JSON string, if present

pub fn is_public(&self) -> bool

Check if this is a public token (uses signatures)

pub fn is_local(&self) -> bool

Check if this is a local token (uses symmetric encryption)

pub fn format_summary(&self) -> String

Get token format summary for debugging

Trait Implementations

impl Clone for ParsedToken

fn clone(&self) -> ParsedToken

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ParsedToken

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

Formats the value using the given formatter.