docs(parser): clarify expiration validation behavior in PasetoParser#69
Merged
Conversation
Add explicit documentation that PasetoParser::default() automatically validates expiration and not-before claims. Include example showing error handling for expired tokens. Changes: - Update README with new "Validating tokens and handling errors" section - Clarify PasetoParser::default() validates exp and nbf claims automatically - Document that PasetoParser::new() creates parser without automatic validations - Add example demonstrating error handling for expired tokens - Update struct-level and method documentation for clarity Closes #26
rrrodzilla
marked this pull request as ready for review
October 5, 2025 22:04
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds explicit documentation that
PasetoParser::default()automatically validates expiration and not-before claims, addressing user confusion reported in issue #26.Changes
Key Documentation Additions
PasetoParser::default()validatesexpandnbfclaims automaticallyPasetoParser::new()creates parser without automatic time-based validationsGenericParserErrorreturn for validation failuresExample Added
Testing
cargo build --no-default-features --features v4_localcargo clippy --all-targets -- -D warningscargo fmtCloses #26