Struct oauth2::CsrfToken

#[must_use]
pub struct CsrfToken(_);

Value used for CSRF protection via the state parameter.

Methods

impl CsrfToken

pub fn new_random() -> Self

Generate a new random, base64-encoded 128-bit CSRF token.

pub fn new_random_len(num_bytes: u32) -> Self

Generate a new random, base64-encoded CSRF token of the specified length.

Arguments

• num_bytes - Number of random bytes to generate, prior to base64-encoding.

Trait Implementations

impl SecretNewType<String> for CsrfToken

fn new(s: String) -> Self

Create a new CsrfToken to wrap the given String.

fn secret(&self) -> &String

Get the secret contained within this CsrfToken.

Security Warning

Leaking this value may compromise the security of the OAuth2 flow.

impl PartialEq<CsrfToken> for CsrfToken

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl Clone for CsrfToken

fn clone(&self) -> CsrfToken

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CsrfToken

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

Formats the value using the given formatter.

impl Serialize for CsrfToken

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

Serialize this value into the given Serde serializer.

impl<'de> Deserialize<'de> for CsrfToken

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.