Struct CsrfToken

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

A Csrf Token

Implementations

impl CsrfToken

pub const fn new(raw: String) -> Self

Constructs a new CsrfToken

pub fn from_static(raw: &'static str) -> Self

Constructs a new CsrfToken from a static reference

pub fn into_boxed_ref(self) -> Box<CsrfTokenRef>

Converts this CsrfToken into a Box<CsrfTokenRef>

This will drop any excess capacity.

pub fn take(self) -> String

Unwraps the underlying String value

impl CsrfToken

pub fn new_random() -> CsrfToken

Make a new random CSRF token.

pub fn new_random_len(len: u32) -> CsrfToken

Make a new random CSRF token with given amount of bytes

Methods from Deref<Target = CsrfTokenRef>

pub fn as_str(&self) -> &str

Provides access to the underlying value as a string slice.

pub fn secret(&self) -> &str

Get the secret from this string.

This function is the same as CsrfToken::as_str, but has another name for searchability, prefer to use this function.

Trait Implementations

impl AsRef<CsrfTokenRef> for CsrfToken

fn as_ref(&self) -> &CsrfTokenRef

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<str> for CsrfToken

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.

impl Borrow<CsrfTokenRef> for CsrfToken

fn borrow(&self) -> &CsrfTokenRef

Immutably borrows from an owned value.

impl Borrow<str> for CsrfToken

fn borrow(&self) -> &str

Immutably borrows from an owned value.

impl Clone for CsrfToken

fn clone(&self) -> CsrfToken

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CsrfToken

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

Formats the value using the given formatter.

impl Deref for CsrfToken

type Target = CsrfTokenRef

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

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

fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer.

impl Display for CsrfToken

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

Formats the value using the given formatter.

impl From<&CsrfTokenRef> for CsrfToken

fn from(s: &CsrfTokenRef) -> Self

Converts to this type from the input type.

impl From<&str> for CsrfToken

fn from(s: &str) -> Self

Converts to this type from the input type.

impl From<Box<CsrfTokenRef>> for CsrfToken

fn from(r: Box<CsrfTokenRef>) -> Self

Converts to this type from the input type.

impl From<Box<str>> for CsrfToken

fn from(s: Box<str>) -> Self

Converts to this type from the input type.

impl<'a> From<Cow<'a, CsrfTokenRef>> for CsrfToken

fn from(r: Cow<'a, CsrfTokenRef>) -> Self

Converts to this type from the input type.

impl From<CsrfToken> for Box<CsrfTokenRef>

fn from(r: CsrfToken) -> Self

Converts to this type from the input type.

impl<'a> From<CsrfToken> for Cow<'a, CsrfTokenRef>

fn from(owned: CsrfToken) -> Self

Converts to this type from the input type.

impl From<CsrfToken> for String

fn from(s: CsrfToken) -> Self

Converts to this type from the input type.

impl From<String> for CsrfToken

fn from(s: String) -> Self

Converts to this type from the input type.

impl FromStr for CsrfToken

type Err = Infallible

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for CsrfToken

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for CsrfToken

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq<&CsrfTokenRef> for CsrfToken

fn eq(&self, other: &&CsrfTokenRef) -> 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 PartialEq<CsrfToken> for &CsrfTokenRef

fn eq(&self, other: &CsrfToken) -> 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 PartialEq<CsrfToken> for CsrfTokenRef

fn eq(&self, other: &CsrfToken) -> 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 PartialEq<CsrfTokenRef> for CsrfToken

fn eq(&self, other: &CsrfTokenRef) -> 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 PartialEq for CsrfToken

fn eq(&self, other: &CsrfToken) -> 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 PartialOrd for CsrfToken

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for CsrfToken

fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.

impl Eq for CsrfToken

impl StructuralPartialEq for CsrfToken