Struct ErrorPage 

#[non_exhaustive]
pub struct ErrorPage<'a> {
    pub status: u16,
    pub title: &'a str,
    pub message: &'a str,
    pub reference: &'a str,
    pub base: &'a str,
}

What an error page shows: the status, its generic title and message, and the request’s reference. Never the code or the cause.

base is the site’s base path ("" at the root, /blog for a site installed in a folder), so the page’s links and stylesheets point inside the site: url builds them as Context::url does for pages.

use web_net::{App, ErrorPage, Output, Render, RenderError, TemplateId, View, get};

/// No templates; its own error pages.
struct Plain;
impl Render for Plain {
    type View<'a> = dyn View + 'a;
    fn template(&self, _: &str) -> Option<TemplateId> { None }
    fn render(&self, _: TemplateId, _: &dyn View, _: &mut Output<'_>) -> Result<(), RenderError> { Ok(()) }
    fn error_page(&self, page: &ErrorPage<'_>, out: &mut Output<'_>) -> Result<bool, RenderError> {
        out.write_str(&format!("{} {}", page.status, page.title))?;
        Ok(true)
    }
}

let app = App::builder().render(Plain).route(get("/", |cx| cx.text(200, "home"))).build()?;
let r = serve_net::testing::respond(&app, b"GET /missing HTTP/1.1\r\nHost: localhost\r\n\r\n");
assert_eq!((r.status, r.text()), (404, "404 Not Found"));

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

status: u16

The status (404).

title: &'a str

Its generic title (Not Found).

message: &'a str

Its generic message.

reference: &'a str

The request’s reference, as the visitor quotes it.

base: &'a str

The site’s base path: "" at the root, /blog in a folder; never a trailing slash.

Implementations

impl<'a> ErrorPage<'a>

pub const fn new( status: u16, title: &'a str, message: &'a str, reference: &'a str, ) -> Self

An error page’s facts at the site’s root, for an engine’s own tests (web-net makes the real ones).

let p = web_net::ErrorPage::new(404, "Not Found", "The page was not found.", "1a-2");
assert_eq!((p.status, p.reference, p.base), (404, "1a-2", ""));

pub const fn with_base(self, base: &'a str) -> Self

The same page for a site installed under base (/blog).

let p = web_net::ErrorPage::new(404, "Not Found", "-", "r").with_base("/blog");
assert_eq!(p.url("/static/site.css").unwrap(), "/blog/static/site.css");

pub fn url(&self, path: &str) -> Result<String, RenderError>

A site path as a URL path, the base path in front: what the page’s links and stylesheets use, so they work for a site in a folder.

let root = web_net::ErrorPage::new(500, "Server Error", "-", "r");
assert_eq!(root.url("/")?, "/");
let blog = root.with_base("/blog");
assert_eq!(blog.url("/static/site.css")?, "/blog/static/site.css");
assert!(blog.url("//elsewhere.example").is_err());

Errors

RenderError url.not_local when path is not a path of the site (as for Context::url).

Trait Implementations

impl<'a> Clone for ErrorPage<'a>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Copy for ErrorPage<'a>

impl<'a> Debug for ErrorPage<'a>

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

Formats the value using the given formatter.

impl<'a> Eq for ErrorPage<'a>

impl<'a> PartialEq for ErrorPage<'a>

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl<'a> StructuralPartialEq for ErrorPage<'a>