Struct actix_redis::RedisSession

source · [−]

pub struct RedisSession(_);

Expand description

Use redis as session storage.

You need to pass an address of the redis server and random value to the constructor of RedisSession. This is private key for cookie session, When this value is changed, all session data is lost.

Constructor panics if key length is less than 32 bytes.

Implementations

source

impl RedisSession

source

pub fn new<S: Into<String>>(addr: S, key: &[u8 ]) -> RedisSession

Create new redis session backend

addr - address of the redis server

source

pub fn ttl(self, ttl: u32) -> Self

Set time to live in seconds for session value.

source

pub fn cookie_name(self, name: &str) -> Self

Set custom cookie name for session ID.

source

pub fn cookie_path(self, path: &str) -> Self

Set custom cookie path.

source

pub fn cookie_domain(self, domain: &str) -> Self

Set custom cookie domain.

source

pub fn cookie_secure(self, secure: bool) -> Self

Set custom cookie secure.

If the secure field is set, a cookie will only be transmitted when the connection is secure - i.e. https.

Default is false.

source

pub fn cookie_max_age(self, max_age: impl Into<Option<Duration>>) -> Self

Set custom cookie max-age.

Use None for session-only cookies.

source

pub fn cookie_same_site(self, same_site: SameSite) -> Self

Set custom cookie SameSite attribute.

By default, the attribute is omitted.

source

pub fn cookie_http_only(self, http_only: bool) -> Self

Set custom cookie HttpOnly policy.

Default is true.

source

pub fn cache_keygen(self, keygen: Box<dyn Fn(&str) -> String>) -> Self

Set a custom cache key generation strategy, expecting session key as input.

Trait Implementations

source

impl<S, B> Transform<S, ServiceRequest> for RedisSession where
 S: Service<ServiceRequest, Response = ServiceResponse, Error = Error> + 'static,
 S::Future: 'static,
 B: 'static,

type Response = ServiceResponse

Responses produced by the service.

type Error = S::Error

Errors produced by the service.

type Transform = RedisSessionMiddleware<S>

The TransformService value created by this factory

type InitError = ()

Errors produced while building a transform service.

type Future = LocalBoxFuture<'static, Result<Self::Transform, Self::InitError>>

The future response value.

source

fn new_transform(&self, service: S) -> Self::Future

Creates and returns a new Transform component, asynchronously

Auto Trait Implementations

impl !RefUnwindSafe for RedisSession

impl !Send for RedisSession

impl !Sync for RedisSession

impl Unpin for RedisSession

impl !UnwindSafe for RedisSession

Blanket Implementations

source

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

source

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

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

const: unstable · source

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

pub fn from(t: T) -> T

Performs the conversion.

source

impl<T> Instrument for T

source

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

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

source

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 for T where
U: From<T>,

const: unstable · source

pub fn into(self) -> U

Performs the conversion.

source

impl<T> Same<T> for T

type Output = T

Should always be Self

source

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

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

source

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

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

pub fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

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

pub fn vzip(self) -> V

source

impl<T> WithSubscriber for T

source

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

source

fn with_current_subscriber(self) -> WithDispatch<Self>

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

Struct actix_redis::RedisSession

Implementations

impl RedisSession

pub fn new<S: Into<String>>(addr: S, key: &[u8]) -> RedisSession

pub fn ttl(self, ttl: u32) -> Self

pub fn cookie_name(self, name: &str) -> Self

pub fn cookie_path(self, path: &str) -> Self

pub fn cookie_domain(self, domain: &str) -> Self

pub fn cookie_secure(self, secure: bool) -> Self

pub fn cookie_max_age(self, max_age: impl Into<Option<Duration>>) -> Self

pub fn cookie_same_site(self, same_site: SameSite) -> Self

pub fn cookie_http_only(self, http_only: bool) -> Self

pub fn cache_keygen(self, keygen: Box<dyn Fn(&str) -> String>) -> Self

Trait Implementations

impl<S, B> Transform<S, ServiceRequest> for RedisSession where S: Service<ServiceRequest, Response = ServiceResponse<B>, Error = Error> + 'static, S::Future: 'static, B: 'static,

type Response = ServiceResponse<B>

type Error = S::Error

type Transform = RedisSessionMiddleware<S>

type InitError = ()

type Future = LocalBoxFuture<'static, Result<Self::Transform, Self::InitError>>

fn new_transform(&self, service: S) -> Self::Future

Auto Trait Implementations

impl !RefUnwindSafe for RedisSession

impl !Send for RedisSession

impl !Sync for RedisSession

impl Unpin for RedisSession

impl !UnwindSafe for RedisSession

Blanket Implementations

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

pub fn type_id(&self) -> TypeId

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

pub fn borrow(&self) -> &T

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

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

impl<T> From<T> for T

pub fn from(t: T) -> T

impl<T> Instrument for T

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

fn in_current_span(self) -> Instrumented<Self>

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

pub fn into(self) -> U

impl<T> Same<T> for T

type Output = T

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

type Error = Infallible

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

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

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

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

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

pub fn vzip(self) -> V

impl<T> WithSubscriber for T

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

fn with_current_subscriber(self) -> WithDispatch<Self>

pub fn new<S: Into<String>>(addr: S, key: &[u8 ]) -> RedisSession

impl<S, B> Transform<S, ServiceRequest> for RedisSession where
S: Service<ServiceRequest, Response = ServiceResponse<B>, Error = Error> + 'static,
S::Future: 'static,
B: 'static,

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

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

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

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

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

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

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

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