Struct FormLoginConfig 

pub struct FormLoginConfig { /* private fields */ }

Form login configuration.

Spring Security Equivalent

Similar to FormLoginConfigurer in Spring Security.

Example

let config = FormLoginConfig::new()
    .login_page("/login")
    .login_processing_url("/login")
    .username_parameter("username")
    .password_parameter("password")
    .default_success_url("/")
    .failure_url("/login?error");

Implementations

impl FormLoginConfig

pub fn new() -> FormLoginConfig

Create a new form login configuration with default values.

pub fn login_page(self, url: &str) -> FormLoginConfig

Set the login page URL (GET request).

Spring Equivalent

formLogin().loginPage("/login")

pub fn login_processing_url(self, url: &str) -> FormLoginConfig

Set the login processing URL (POST request).

Spring Equivalent

formLogin().loginProcessingUrl("/login")

pub fn username_parameter(self, param: &str) -> FormLoginConfig

Set the username parameter name.

Spring Equivalent

formLogin().usernameParameter("username")

pub fn password_parameter(self, param: &str) -> FormLoginConfig

Set the password parameter name.

Spring Equivalent

formLogin().passwordParameter("password")

pub fn default_success_url(self, url: &str) -> FormLoginConfig

Set the default success URL.

Spring Equivalent

formLogin().defaultSuccessUrl("/")

pub fn always_use_default_success_url(self, always: bool) -> FormLoginConfig

Always redirect to default success URL, ignoring saved request.

Spring Equivalent

formLogin().defaultSuccessUrl("/", true)

pub fn failure_url(self, url: &str) -> FormLoginConfig

Set the failure URL.

Spring Equivalent

formLogin().failureUrl("/login?error")

pub fn logout_url(self, url: &str) -> FormLoginConfig

Set the logout URL (POST request).

Spring Equivalent

logout().logoutUrl("/logout")

pub fn logout_success_url(self, url: &str) -> FormLoginConfig

Set the logout success URL.

Spring Equivalent

logout().logoutSuccessUrl("/login?logout")

pub fn remember_me_parameter(self, param: &str) -> FormLoginConfig

Enable remember-me with the given parameter name.

pub fn get_login_page(&self) -> &str

Get the login page URL.

pub fn get_login_processing_url(&self) -> &str

Get the login processing URL.

pub fn get_username_parameter(&self) -> &str

Get the username parameter name.

pub fn get_password_parameter(&self) -> &str

Get the password parameter name.

pub fn get_default_success_url(&self) -> &str

Get the default success URL.

pub fn is_always_use_default_success_url(&self) -> bool

Check if always use default success URL.

pub fn get_failure_url(&self) -> &str

Get the failure URL.

pub fn get_logout_url(&self) -> &str

Get the logout URL.

pub fn get_logout_success_url(&self) -> &str

Get the logout success URL.

pub fn get_remember_me_parameter(&self) -> Option<&str>

Get the remember-me parameter name.

Trait Implementations

impl Clone for FormLoginConfig

fn clone(&self) -> FormLoginConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for FormLoginConfig

fn default() -> FormLoginConfig

Returns the “default value” for a type.