Struct tower_surf::Surf

pub struct Surf { /* private fields */ }

A layer providing the Token extension.

On every request, it will create a cookie for the current visitor if one has not already been created. The session ID used is an i128 generated by the rand crate.

Implementations

impl Surf

pub fn new(secret: impl Into<String>) -> Self

Creates a new Surf layer with the provided secret and default token configuration.

pub fn cookie_name(self, cookie_name: impl Into<String>) -> Self

Sets the cookie name. Note that this will be previed with __HOST- unless you have disabled it with prefix. The default value is csrf_token.

pub fn expires(self, expires: Expiration) -> Self

Sets the cookie’s expiration. The default value is Expiration::Session.

pub fn header_name(self, header_name: impl Into<String>) -> Self

Sets the header name used when validating the request. The default value is X-CSRF-Token.

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

Sets the HTTPOnly attribute of the cookie. The default value is true.

⚠️ Warning: This should generally not be set to false. See: HttpOnly Cookie Attribute.

pub fn prefix(self, prefix: bool) -> Self

Sets whether to prefix the cookie name with __HOST-. The default value is true.

See: Cookie Name.

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

Sets the SameSite attribute of the cookie. The default value is SameSite::Strict.

See: SameSite Cookie Attribute.

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

Sets the secure attribute of the cookie. Note that this is required to be false for cookies to work on localhost. The default value is true.

See: Secure Cookie Attribute.

Trait Implementations

impl Clone for Surf

fn clone(&self) -> Surf

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<S> Layer<S> for Surf

type Service = CookieManager<SurfService<GuardService<S>>>

The wrapped service

fn layer(&self, inner: S) -> Self::Service

Wrap the given service with the middleware, returning a new service that has been decorated with the middleware.