Struct goose_eggs::drupal::Login

pub struct Login<'a> { /* fields omitted */ }

Set one or more defaults when logging in through the standard drupal user-login-form.

This object is passed to log_in to set a custom default username and/or password and/or log in url and/or the required title after login.

Example

use goose_eggs::drupal::Login;

fn examples() {
    // Manually build a Login structure with custom username and password.
    let _login = Login::new(Some("foo"), Some("bar"), None, None);

    // Call `Login::username_password` to build the same.
    let mut login = Login::username_password("foo", "bar");

    // Now also change the url and expected title.
    login.unwrap().update_url_title("/custom/user/login", "Custom title");
}

Implementations

impl<'a> Login<'a>

pub fn new(
    username: Option<&'a str>,
    password: Option<&'a str>,
    url: Option<&'a str>,
    title: Option<&'a str>
) -> Option<Login<'a>>

Create a new Login object, specifying username, password, url, and expected title.

It’s generally preferred to use a helper such as Login::username_password or Login::url_title instead of invoking this function directly.

Example

use goose_eggs::drupal::Login;

let _login = Login::new(
    // Set a default username of "foo".
    Some("foo"),
    // Set a default password of "bar".
    Some("bar"),
    // Set a custom log-in path of "/custom/login/path".
    Some("/custom/login/path"),
    // Set a custom title to validate after log-in.
    Some("Custom Title"),
);

pub fn username(username: &'a str) -> Option<Login<'a>>

Create a Login object setting a custom default username.

The password will remain the default of password. The login url will remain the default of /user/login. After login the title will be validated to confirm it include’s the username. The username and password defaults can still be overridden by the GOOSE_USER and GOOSE_PASS environment variables.

Example

use goose_eggs::drupal::Login;

let _login = Login::username("foo");

pub fn password(password: &'a str) -> Option<Login<'a>>

Create a Login object setting a custom default password.

The username will remain the default of username. The login url will remain the default of /user/login. After login the title will be validated to confirm it include’s the username. The username and password defaults can still be overridden by the GOOSE_USER and GOOSE_PASS environment variables.

Example

use goose_eggs::drupal::Login;

let _login = Login::password("bar");

pub fn username_password(
    username: &'a str,
    password: &'a str
) -> Option<Login<'a>>

Create a Login object setting a custom default username and password.

The login url will remain the default of /user/login. After login the title will be validated to confirm it include’s the username. The username and password defaults can still be overridden by the GOOSE_USER and GOOSE_PASS environment variables.

Example

use goose_eggs::drupal::Login;

let _login = Login::username_password("foo", "bar");

pub fn url(url: &'a str) -> Option<Login<'a>>

Create a Login object with a custom default login url.

The username will remain the default of username. The password will remain the default of password. After login the title will be validated to confirm it include’s the username. The username and password defaults can still be overridden by the GOOSE_USER and GOOSE_PASS environment variables.

Example

use goose_eggs::drupal::Login;

let _login = Login::password("bar");

Example

use goose_eggs::drupal::Login;

let _login = Login::url("/custom/user/login");

pub fn title(title: &'a str) -> Option<Login<'a>>

Create a Login object with a custom expected title after login.

The username will remain the default of username. The password will remain the default of password. The login url will remain the default of /user/login. The username and password defaults can still be overridden by the GOOSE_USER and GOOSE_PASS environment variables.

Example

use goose_eggs::drupal::Login;

let _login = Login::password("bar");

Example

use goose_eggs::drupal::Login;

let _login = Login::title("Custom title");

pub fn url_title(url: &'a str, title: &'a str) -> Option<Login<'a>>

Create a Login object with custom default url and a custom expected title after login.

The username will remain the default of username. The password will remain the default of password. The username and password defaults can still be overridden by the GOOSE_USER and GOOSE_PASS environment variables.

Example

use goose_eggs::drupal::Login;

let _login = Login::password("bar");

Example

use goose_eggs::drupal::Login;

let _login = Login::url_title("/custom/login/path", "Custom title");

pub fn update_username(self, username: &'a str) -> Option<Self>

Update a Login object, changing the default username.

The password, url and title fields will not be changed.

The username and password defaults can still be overridden by the GOOSE_USER and GOOSE_PASS environment variables.

Example

use goose_eggs::drupal::Login;

let login =
    Login::password("bar")
        .unwrap()
        .update_username("foo");

pub fn update_password(self, password: &'a str) -> Option<Self>

Update a Login object, changing the default password.

The username, url and title fields will not be changed.

The username and password defaults can still be overridden by the GOOSE_USER and GOOSE_PASS environment variables.

Example

use goose_eggs::drupal::Login;

let login =
    Login::username("foo")
        .unwrap()
        .update_password("bar");

pub fn update_username_password(
    self,
    username: &'a str,
    password: &'a str
) -> Option<Self>

Update a Login object, changing the default username and password.

The url and title fields will not be changed.

The username and password defaults can still be overridden by the GOOSE_USER and GOOSE_PASS environment variables.

Example

use goose_eggs::drupal::Login;

let login =
    Login::username_password("foo", "bar")
        .unwrap()
        .update_username_password("changed-username", "changed-password");

pub fn update_url(self, url: &'a str) -> Option<Self>

Update a Login object, changing the default login url.

The username, password and title fields will not be changed.

The username and password defaults can still be overridden by the GOOSE_USER and GOOSE_PASS environment variables.

Example

use goose_eggs::drupal::Login;

let login =
    Login::username("foo")
        .unwrap()
        .update_url("/custom/user/login");

pub fn update_title(self, title: &'a str) -> Option<Self>

Update a Login object, changing the expected title after login.

The username and password fields will not be changed.

The username and password defaults can still be overridden by the GOOSE_USER and GOOSE_PASS environment variables.

Example

use goose_eggs::drupal::Login;

let login =
    Login::username("foo")
        .unwrap()
        .update_title("Custom Title");

pub fn update_url_title(self, url: &'a str, title: &'a str) -> Option<Self>

Update a Login object, changing the default login url and the expected title after login.

The username and password fields will not be changed.

The username and password defaults can still be overridden by the GOOSE_USER and GOOSE_PASS environment variables.

Example

use goose_eggs::drupal::Login;

let login =
    Login::username_password("foo", "password")
        .unwrap()
        .update_url_title("/custom/user/login", "Custom Title");