Struct goose_eggs::Validate

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

Define one or more items to be validated in a web page response.

This structure is passed to validate_and_load_static_assets.

Example

use goose_eggs::Validate;

fn examples() {
    // Manually build a Validate strucuture that validates the page title and
    // some arbitrary texts in the response html.
    let _validate = Validate::new(
        None, Some("my page"), vec!["foo", r#"<a href="bar">"#], vec![], None
    );

    // Use `title_texts()` helper to perform the same validation.
    let _validate = Validate::title_texts("my page", vec!["foo", r#"<a href="bar">"#]);

    // Use `title_text()` helper to perform similar validation, validating only
    // one text on the page.
    let _validate = Validate::title_text("my page", r#"<a href="foo">"#);
}

Implementations

impl<'a> Validate<'a>

pub fn new(
    status: Option<u16>,
    title: Option<&'a str>,
    texts: Vec<&'a str>,
    headers: Vec<&'a Header<'a>>,
    redirect: Option<bool>
) -> Validate<'a>

Create a new Validate struct, specifying status, title, texts, headers, and redirect.

Example

use goose_eggs::{Header, Validate};

let _validate = Validate::new(
    // Validate the response status code.
    Some(404),
    // Validate the response page title.
    Some("Page Not Found"),
    // Validate arbitrary text on the response page.
    vec!["Oops, something went wrong!"],
    // Validate that the response was sent via https.
    vec![&Header::name_value("scheme", "https")],
    // Validate that the page redirects.
    Some(true),
);

pub fn none() -> Validate<'a>

Create a new Validate struct that validates nothing.

This is useful to load all static assets and return the body of the response.

This structure is passed to validate_and_load_static_assets.

Example

use goose_eggs::Validate;

let _validate = Validate::none();

pub fn status(status: u16) -> Validate<'a>

Create a Validate object to validate the response status code.

This structure is passed to validate_and_load_static_assets.

Example

use goose_eggs::{Header, Validate};

let _validate = Validate::status(200);

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

Create a Validate object to validate the response title.

This structure is passed to validate_and_load_static_assets.

Example

use goose_eggs::{Header, Validate};

let _validate = Validate::title("Home page");

pub fn text(text: &'a str) -> Validate<'a>

Create a Validate object to validate specific text is on the response page.

This structure is passed to validate_and_load_static_assets.

Example

use goose_eggs::{Header, Validate};

let _validate = Validate::text("This text should be on the page.");

pub fn title_text(title: &'a str, text: &'a str) -> Validate<'a>

Create a Validate object to validate the response has the correct title and also contains specific text.

This structure is passed to validate_and_load_static_assets.

Example

use goose_eggs::{Header, Validate};

let _validate = Validate::title_text("Example", "This text should be on the page.");

pub fn texts(texts: Vec<&'a str>) -> Validate<'a>

Create a Validate object to validate that the response page contains multiple specific texts.

This structure is passed to validate_and_load_static_assets.

Example

use goose_eggs::{Header, Validate};

let _validate = Validate::texts(vec!["This text should be on the page.", "And also this", r#"<span>and this</a>"#]);

pub fn title_texts(title: &'a str, texts: Vec<&'a str>) -> Validate<'a>

Create a Validate object to validate the response title and that the page contains multiple specific texts.

This structure is passed to validate_and_load_static_assets.

Example

use goose_eggs::{Header, Validate};

let _validate = Validate::title_texts("Example", vec!["This text should be on the page.", "And also this", r#"<span>and this</a>"#]);

pub fn header(header: &'a Header<'a>) -> Validate<'a>

Create a Validate object to validate the response included a specific header.

This structure is passed to validate_and_load_static_assets.

Example

use goose_eggs::{Header, Validate};

let _validate = Validate::header(&Header::name("x-cache"));

pub fn headers(headers: Vec<&'a Header<'a>>) -> Validate<'a>

Create a Validate object to validate that the response included multiple specific headers.

This structure is passed to validate_and_load_static_assets.

Example

use goose_eggs::{Header, Validate};

let _validate = Validate::headers(vec![&Header::name("x-cache"), &Header::name("x-generator")]);

pub fn redirect(redirect: bool) -> Validate<'a>

Create a Validate object to validate whether or not the response redirected.

This structure is passed to validate_and_load_static_assets.

Example

use goose_eggs::Validate;

// Verify the response redirected.
let _validate = Validate::redirect(true);

// Verify the response did not redirect.
let _validate = Validate::redirect(false);

pub fn update_status(self, status: u16) -> Self

Update a Validate object, changing the expected status returned when loading the page.

This structure is passed to validate_and_load_static_assets.

Example

use goose_eggs::{Header, Validate};

let _validate = Validate::title("Home page")
                    .update_status(200);

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

Update a Validate object, changing the title expected on the page.

This structure is passed to validate_and_load_static_assets.

Example

use goose_eggs::{Header, Validate};

let _validate = Validate::status(200)
                    .update_title("Home Page");

pub fn update_text(self, text: &'a str) -> Self

Update a Validate object, changing the text validated on the page.

Use Validate::update_texts if you want to validate multiple texts on the page.

This structure is passed to validate_and_load_static_assets.

Example

use goose_eggs::{Header, Validate};

let _validate = Validate::title("Home Page")
                    .update_text("Welcome to my Home Page");

pub fn update_texts(self, texts: Vec<&'a str>) -> Self

Update a Validate object, changing the texts validated on the page.

Use Validate::update_text if you want to validate only one text on the page.

This structure is passed to validate_and_load_static_assets.

Example

use goose_eggs::{Header, Validate};

let _validate = Validate::title("Home Page")
                    .update_texts(vec!["Welcome", "Log in"]);

pub fn update_header(self, header: &'a Header<'a>) -> Self

Update a Validate object, changing the header expected on the page.

Use Validate::update_headers if you want to validate multiple headers on the page.

This structure is passed to validate_and_load_static_assets.

Example

use goose_eggs::{Header, Validate};

let _validate = Validate::title("Home Page")
                    .update_header(&Header::name("x-cache"));

pub fn update_headers(self, headers: Vec<&'a Header<'a>>) -> Self

Update a Validate object, changing the headers expected on the page.

Use Validate::update_header if you want to validate only one header on the page.

This structure is passed to validate_and_load_static_assets.

Example

use goose_eggs::{Header, Validate};

let _validate = Validate::title("Home Page")
                    .update_headers(vec![&Header::name("x-cache"), &Header::name("x-generator")]);

pub fn update_redirect(self, redirect: bool) -> Self

Update a Validate object, changing whether or not the page should redirect.

This structure is passed to validate_and_load_static_assets.

Example

use goose_eggs::Validate;

// Verify the response redirected.
let _validate = Validate::title("Home Page")
                    .update_redirect(false);

Trait Implementations

impl<'a> Clone for Validate<'a>

fn clone(&self) -> Validate<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Validate<'a>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.