Struct roa::Status [−][src]
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
[src]
pub fn new(
status_code: StatusCode,
message: impl ToString,
expose: bool
) -> Status
[src]
status_code: StatusCode,
message: impl ToString,
expose: bool
) -> Status
Construct an error.
Trait Implementations
impl Clone for Status
[src]
impl Debug for Status
[src]
impl Display for Status
[src]
impl<'a, S> Endpoint<'a, S> for Status
[src]
status endpoint.
pub fn call<'async_trait>(
&'a self,
_ctx: &'a mut Context<S>
) -> Pin<Box<dyn Future<Output = Result<(), Status>> + 'async_trait, Global>> where
'a: 'async_trait,
Status: 'async_trait,
[src]
&'a self,
_ctx: &'a mut Context<S>
) -> Pin<Box<dyn Future<Output = Result<(), Status>> + 'async_trait, Global>> where
'a: 'async_trait,
Status: 'async_trait,
impl Eq for Status
[src]
impl<E> From<E> for Status where
E: Error,
[src]
E: Error,
impl PartialEq<Status> for Status
[src]
impl StructuralEq for Status
[src]
impl StructuralPartialEq for Status
[src]
Auto Trait Implementations
impl RefUnwindSafe for Status
impl Send for Status
impl Sync for Status
impl Unpin for Status
impl UnwindSafe for Status
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
pub fn borrow_mut(&mut self) -> &mut T
[src]
impl<S, T> EndpointExt<S> for T where
T: for<'a> Endpoint<'a, S>,
[src]
T: for<'a> Endpoint<'a, S>,
impl<Q, K> Equivalent<K> for Q where
K: Borrow<Q> + ?Sized,
Q: Eq + ?Sized,
[src]
K: Borrow<Q> + ?Sized,
Q: Eq + ?Sized,
pub fn equivalent(&self, key: &K) -> bool
[src]
impl<T> From<!> for T
[src]
impl<T> From<T> for T
[src]
impl<T> Instrument for T
[src]
pub fn instrument(self, span: Span) -> Instrumented<Self>
[src]
pub fn in_current_span(self) -> Instrumented<Self>
[src]
impl<T> Instrument for T
[src]
pub fn instrument(self, span: Span) -> Instrumented<Self>
[src]
pub fn in_current_span(self) -> Instrumented<Self>
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> Same<T> for T
type Output = T
Should always be Self
impl<T> State for T where
T: 'static + Clone + Send + Sync,
[src]
T: 'static + Clone + Send + Sync,
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
pub fn to_owned(&self) -> T
[src]
pub fn clone_into(&self, target: &mut T)
[src]
impl<T> ToString for T where
T: Display + ?Sized,
[src]
T: Display + ?Sized,
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
[src]
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
V: MultiLane<T>,