Struct UseCookieOptions

pub struct UseCookieOptions<T, E, D> { /* private fields */ }

Options for use_cookie_with_options.

Implementations

impl<T, E, D> UseCookieOptions<T, E, D>

pub fn max_age<OptionInnerType>( self, value: impl Into<Option<OptionInnerType>>, ) -> Self

where OptionInnerType: Into<i64>,

Max-Age of the cookie in milliseconds. The returned signal will turn to None after the max age is reached. Default: None

The cookie storage model specification states that if both expires and max_age is set, then max_age takes precedence, but not all clients may obey this, so if both are set, they should point to the same date and time!

If neither of expires and max_age is set, the cookie will be session-only and removed when the user closes their browser.

pub fn expires<OptionInnerType>( self, value: impl Into<Option<OptionInnerType>>, ) -> Self

where OptionInnerType: Into<i64>,

Expiration date-time of the cookie as UNIX timestamp in seconds. The signal will turn to None after the expiration date-time is reached. Default: None

The cookie storage model specification states that if both expires and max_age is set, then max_age takes precedence, but not all clients may obey this, so if both are set, they should point to the same date and time!

If neither of expires and max_age is set, the cookie will be session-only and removed when the user closes their browser.

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

Specifies the HttpOnly cookie attribute. When true, the HttpOnly attribute is set; otherwise it is not. By default, the HttpOnly attribute is not set.

Be careful when setting this to true, as compliant clients will not allow client-side JavaScript to see the cookie in document.cookie.

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

Specifies the value for the Secure cookie attribute. When true, the Secure attribute is set; otherwise it is not. By default, the Secure attribute is not set.

Be careful when setting this to true, as compliant clients will not send the cookie back to the server in the future if the browser does not have an HTTPS connection. This can lead to hydration errors.

pub fn domain<OptionInnerType>( self, value: impl Into<Option<OptionInnerType>>, ) -> Self

where OptionInnerType: Into<String>,

Specifies the value for the Domain cookie attribute. By default, no domain is set, and most clients will consider applying the cookie only to the current domain.

pub fn path<OptionInnerType>( self, value: impl Into<Option<OptionInnerType>>, ) -> Self

where OptionInnerType: Into<String>,

Specifies the value for the Path cookie attribute. By default, the path is considered the “default path”.

pub fn same_site<OptionInnerType>( self, value: impl Into<Option<OptionInnerType>>, ) -> Self

where OptionInnerType: Into<SameSite>,

Specifies the value for the SameSite cookie attribute.

• 'Some(SameSite::Lax)' will set the SameSite attribute to Lax for lax same-site enforcement.
• 'Some(SameSite::None)' will set the SameSite attribute to None for an explicit cross-site cookie.
• 'Some(SameSite::Strict)' will set the SameSite attribute to Strict for strict same-site enforcement.
• None will not set the SameSite attribute (default).

More information about the different enforcement levels can be found in the specification.

pub fn default_value<New__T>( self, value: Option<New__T>, ) -> UseCookieOptions<New__T, E, D>

The default cookie value in case the cookie is not set. Defaults to None.

pub fn readonly(self, value: bool) -> Self

If true the returned WriteSignal will not affect the actual cookie. Default: false

pub fn ssr_cookies_header_getter( self, value: impl Fn() -> Option<String> + 'static, ) -> Self

Getter function to return the string value of the cookie header. When you use one of the features "axum", "actix" or "spin" there’s a valid default implementation provided.

pub fn ssr_set_cookie(self, value: impl Fn(&Cookie<'_>) + 'static) -> Self

Function to add a set cookie header to the response on the server. When you use one of the features "axum", "actix" or "spin" there’s a valid default implementation provided.

pub fn on_error<New__E, New__D>( self, value: Rc<dyn Fn(CodecError<New__E, New__D>)>, ) -> UseCookieOptions<T, New__E, New__D>

Callback for encoding/decoding errors. Defaults to logging the error to the console.

Trait Implementations

impl<T, E, D> Default for UseCookieOptions<T, E, D>

fn default() -> Self

Returns the “default value” for a type.