Struct roa_core::Status

pub struct Status {
    pub status_code: StatusCode,
    pub message: String,
    pub expose: bool,
}

The Status of roa.

Fields

status_code: StatusCode

StatusCode will be responded to client if Error is thrown by the top middleware.

Example

use roa_core::{App, Context, Next, Result, MiddlewareExt, throw};
use roa_core::http::StatusCode;

let app = App::new().gate(gate).end(end);
async fn gate(ctx: &mut Context, next: Next<'_>) -> Result {
    ctx.resp.status = StatusCode::OK;
    next.await // not caught
}

async fn end(ctx: &mut Context) -> Result {
    throw!(StatusCode::IM_A_TEAPOT, "I'm a teapot!"); // throw
    unreachable!()
}

message: String

Data will be written to response body if self.expose is true. StatusCode will be responded to client if Error is thrown by the top middleware.

Example

use roa_core::{App, Context, Result, Status};
use roa_core::http::StatusCode;

let app = App::new().end(end);

async fn end(ctx: &mut Context) -> Result {
    Err(Status::new(StatusCode::IM_A_TEAPOT, "I'm a teapot!", false)) // message won't be exposed to user.
}

expose: bool

if message exposed.

Implementations

impl Status

pub fn new(
    status_code: StatusCode,
    message: impl ToString,
    expose: bool
) -> Self

Construct an error.

Trait Implementations

impl Clone for Status

fn clone(&self) -> Status

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Status

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

Formats the value using the given formatter.

impl Display for Status

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

Formats the value using the given formatter.

impl<'a, S> Endpoint<'a, S> for Status

status endpoint.

fn call<'async_trait>(
    &'a self,
    _ctx: &'a mut Context<S>
) -> Pin<Box<dyn Future<Output = Result> + 'async_trait>> where
    'a: 'async_trait,
    Self: 'async_trait, 

Call this endpoint.

impl<E> From<E> for Status where
    E: Error, 

fn from(err: E) -> Self

Performs the conversion.

impl PartialEq<Status> for Status

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl Eq for Status

impl StructuralEq for Status

impl StructuralPartialEq for Status