Struct Forbidden

pub struct Forbidden<R>(pub Option<R>);

Sets the status of the response to 403 (Forbidden).

If a responder is supplied, the remainder of the response is delegated to it. If there is no responder, the body of the response will be empty.

Examples

A 403 Forbidden response without a body:

use rocket::response::status;

let response = status::Forbidden::<()>(None);

A 403 Forbidden response with a body:

use rocket::response::status;

let response = status::Forbidden(Some("error message"));

Tuple Fields

0: Option<R>

Trait Implementations

impl<R: Clone> Clone for Forbidden<R>

fn clone(&self) -> Forbidden<R>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<R: Debug> Debug for Forbidden<R>

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

Formats the value using the given formatter.

impl<R: PartialEq> PartialEq for Forbidden<R>

fn eq(&self, other: &Forbidden<R>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'r, R: Responder<'r>> Responder<'r> for Forbidden<R>

Sets the status code of the response to 403 Forbidden. If the responder is Some, it is used to finalize the response.

fn respond_to(self, req: &Request<'_>) -> Result<Response<'r>, Status>

Returns Ok if a Response could be generated successfully. Otherwise, returns an Err with a failing Status.

impl<R> StructuralPartialEq for Forbidden<R>