Struct OAuth2State 

pub struct OAuth2State(/* private fields */);

Type-safe wrapper for OAuth2 state parameters.

This provides compile-time safety to prevent mixing up OAuth2 state strings with other string types. OAuth2 state parameters are base64url-encoded JSON that carries CSRF protection and flow parameters between authorization requests and callbacks. Proper validation is critical for security.

Implementations

impl OAuth2State

pub fn new(state: String) -> Result<Self, OAuth2Error>

Creates a new OAuth2State from a string with validation.

This constructor validates the OAuth2 state format to ensure it meets security requirements for CSRF protection and parameter integrity.

Arguments

• state - The OAuth2 state string (should be base64url-encoded)

Returns

• Ok(OAuth2State) - If the state is valid
• Err(OAuth2Error) - If the state is invalid

Validation Rules

• Must not be empty
• Must be valid base64url encoding
• Must contain valid JSON when decoded
• Must be reasonable length

pub fn as_str(&self) -> &str

Returns the OAuth2 state as a string slice.

Returns

• A string slice containing the OAuth2 state

pub fn contains(&self, needle: char) -> bool

Checks if the state contains a substring.

Arguments

• needle - The substring to search for

Returns

• true if the substring is found, false otherwise

Trait Implementations

impl Clone for OAuth2State

fn clone(&self) -> OAuth2State

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OAuth2State

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

Formats the value using the given formatter.

impl Display for OAuth2State

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

Formats the value using the given formatter.

impl PartialEq for OAuth2State

fn eq(&self, other: &OAuth2State) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for OAuth2State