Struct Denial 

pub struct Denial { /* private fields */ }

A refusal from a gate: what the visitor sees, and a stable code for logs and events (never shown to the visitor).

use web_net::Denial;

let d = Denial::forbidden("admin.only");
assert_eq!((d.status(), d.code()), (403, "admin.only"));
assert_eq!(d.to_string(), "denied (403): admin.only");

Implementations

impl Denial

pub const fn sign_in(code: &'static str) -> Self

Sign in first.

use web_net::{Denial, DenialKind};

let d = Denial::sign_in("session.none");
assert_eq!((d.kind(), d.status()), (DenialKind::SignIn, 401));

pub const fn forbidden(code: &'static str) -> Self

403 Forbidden.

use web_net::Denial;

assert_eq!(Denial::forbidden("account.locked").status(), 403);

pub const fn hidden(code: &'static str) -> Self

404 Not Found, hiding that the resource exists.

use web_net::Denial;

assert_eq!(Denial::hidden("post.draft").status(), 404);

pub const fn with_status(status: u16, code: &'static str) -> Self

Another client-error status (429, 451, …). A status outside 400 to 499 is answered as 403: a gate cannot turn a denial into a success or a server error.

use web_net::Denial;

assert_eq!(Denial::with_status(429, "rate.limited").status(), 429);
assert_eq!(Denial::with_status(500, "oops").status(), 403);

pub const fn unavailable(code: &'static str) -> Self

503 Service Unavailable: the gate cannot decide now (a store it needs is down) and fails closed. Clients and load balancers read it as “try again”, not “you may not”.

use web_net::Denial;

let d = Denial::unavailable("gate.unavailable").retry_after(5);
assert_eq!((d.status(), d.retry_seconds()), (503, Some(5)));

pub const fn retry_after(self, seconds: u32) -> Self

A Retry-After: <seconds> field on the refusal. Sent only when the status is 429 or 503, the statuses a client retries.

use web_net::Denial;

let d = Denial::with_status(429, "rate.limited").retry_after(30);
assert_eq!(d.retry_seconds(), Some(30));

pub const fn retry_seconds(&self) -> Option<u32>

The Retry-After seconds, if any.

use web_net::Denial;

assert_eq!(Denial::forbidden("account.locked").retry_seconds(), None);
assert_eq!(Denial::unavailable("store.down").retry_after(5).retry_seconds(), Some(5));

pub fn with_cookie(self, set_cookie: impl Into<Box<str>>) -> Self

A Set-Cookie value the refusal carries (a dead session’s cookie cleared): written on the denial’s reply.

use web_net::Denial;

let d = Denial::sign_in("session.expired").with_cookie("sid=; Max-Age=0; Path=/");
assert_eq!(d.cookie(), Some("sid=; Max-Age=0; Path=/"));

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

The Set-Cookie value, if any.

use web_net::Denial;

assert_eq!(Denial::forbidden("account.locked").cookie(), None);
assert!(Denial::sign_in("session.expired").with_cookie("sid=; Max-Age=0").cookie().is_some());

pub const fn kind(&self) -> DenialKind

What the visitor is told.

use web_net::{Denial, DenialKind};

assert_eq!(Denial::unavailable("store.down").kind(), DenialKind::Unavailable);

pub const fn code(&self) -> &'static str

The code for logs and events.

use web_net::Denial;

assert_eq!(Denial::hidden("post.draft").code(), "post.draft");

pub const fn status(&self) -> u16

The status answered when no sign-in page applies.

use web_net::Denial;

assert_eq!(Denial::sign_in("session.none").status(), 401);
assert_eq!(Denial::unavailable("store.down").status(), 503);

Trait Implementations

impl Clone for Denial

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Denial

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

Formats the value using the given formatter.

impl Display for Denial

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

Formats the value using the given formatter.

impl Eq for Denial

impl Error for Denial

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.

impl From<Denial> for Error

fn from(d: Denial) -> Self

Converts to this type from the input type.

impl PartialEq for Denial

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Denial