# Struct actix_session::storage::SessionKey

source ·

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

Expand description

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§

source §

### impl AsRef<str> for SessionKey

source §

#### fn as_ref(&self) -> &str

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

### impl Debug for SessionKey

source §

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

Formats the value using the given formatter. Read more
source §

### impl From<SessionKey> for String

source §

#### fn from(key: SessionKey) -> Self

Converts to this type from the input type.
source §

### impl PartialEq for SessionKey

source §

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

This method tests for `self` and `other` values to be equal, and is used by `==`.
1.0.0 · source §

#### 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.
source §

### impl TryFrom<String> for SessionKey

§

#### type Error = InvalidSessionKeyError

The type returned in the event of a conversion error.
source §

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

Performs the conversion.
source §

### impl Eq for SessionKey

source §

### impl StructuralPartialEq for SessionKey

## Auto Trait Implementations§

§

### impl RefUnwindSafe for SessionKey

§

### impl Send for SessionKey

§

### impl Sync for SessionKey

§

### impl Unpin for SessionKey

§

### impl UnwindSafe for SessionKey

## Blanket Implementations§

source §

### impl<T> Any for T
where T: 'static + ?Sized,

source §

#### fn type_id(&self) -> TypeId

Gets the `TypeId` of `self`. Read more
source §

### impl<T> Borrow<T> for T
where T: ?Sized,

source §

#### fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source §

### impl<T> BorrowMut<T> for T
where T: ?Sized,

source §

#### fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source §

### impl<T> From<T> for T

source §

#### fn from(t: T) -> T

Returns the argument unchanged.

§

### impl<T> Instrument for T

§

#### fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [`Span`], returning an `Instrumented` wrapper. Read more
§

#### fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current `Span`, returning an `Instrumented` wrapper. Read more
source §

### impl<T, U> Into<U> for T
where U: From<T>,

source §

#### fn into(self) -> U

Calls `U::from(self)`.

That is, this conversion is whatever the implementation of `From<T> for U` chooses to do.

source §

### impl<T> Same for T

§

#### type Output = T

Should always be `Self`
source §

### impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

#### type Error = Infallible

The type returned in the event of a conversion error.
source §

#### fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source §

### impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

#### type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source §

#### fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

### impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

#### fn vzip(self) -> V

§

### impl<T> WithSubscriber for T

§

#### fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided `Subscriber` to this type, returning a [`WithDispatch`] wrapper. Read more
§

#### fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default `Subscriber` to this type, returning a [`WithDispatch`] wrapper. Read more