Struct actix_session::storage::SessionKey

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

A session key, the string stored in a client-side cookie to associate a user with its session state on the backend.

Validation

Session keys are stored as cookies, therefore they cannot be arbitrary long. Session keys are required to be smaller than 4064 bytes.

use actix_session::storage::SessionKey;

let key: String = std::iter::repeat('a').take(4065).collect();
let session_key: Result<SessionKey, _> = key.try_into();
assert!(session_key.is_err());

Trait Implementations

impl AsRef<str> for SessionKey

fn as_ref(&self) -> &str

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

impl Debug for SessionKey

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

Formats the value using the given formatter.

impl From<SessionKey> for String

fn from(key: SessionKey) -> Self

Converts to this type from the input type.

impl PartialEq for SessionKey

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

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

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

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

impl TryFrom<String> for SessionKey

type Error = InvalidSessionKeyError

The type returned in the event of a conversion error.

fn try_from(val: String) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for SessionKey

impl StructuralEq for SessionKey

impl StructuralPartialEq for SessionKey