Struct nebula_status::Status

pub struct Status<T = Empty> where
    T: StatusData,  { /* fields omitted */ }

An HTTP status code bundled with associated data.

Code that creates a new instance of Status should set any related response headers before returning it.

Implementations

impl Status

pub fn new(code: StatusCode) -> Status<Empty>

Create a new Status without any associated data. This will be converted to the specified status code with associated headers and no body.

pub fn with_message(code: StatusCode, msg: String) -> Status<String>

Create a new Status with associated data of type String. Useful for returning basic error messages.

pub fn with_data<T: StatusData>(code: StatusCode, data: T) -> Status<T>

Create a new Status with associated arbitrary data. Useful for returning a struct that can be serialized into e.g. JSON.

impl<T: StatusData> Status<T>

pub fn code(&self) -> &StatusCode

Gain a reference to this Status' status code.

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

Attempts to parse the data contained in this Status as a &str.

The Content-Type header is used to help determine if the data is meant to be parsed as text or not.

pub fn data(&self) -> &T

Returns a reference to the contained data.

pub fn bytes(&self) -> &[u8]

pub fn headers(&self) -> &HeaderMap<HeaderValue>

Gain an immutable view into the headers map.

pub fn headers_mut(&mut self) -> &mut HeaderMap<HeaderValue>

Gain a mutable reference to the headers map.

Trait Implementations

impl<T: Clone> Clone for Status<T> where
    T: StatusData, 

fn clone(&self) -> Status<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for Status<T> where
    T: StatusData, 

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

Formats the value using the given formatter.

impl<T: StatusData> Display for Status<T>

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

Formats the value using the given formatter.

impl<T: Eq> Eq for Status<T> where
    T: StatusData, 

impl<T: StatusData> Error for Status<T>

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

The lower-level source of this error, if any.

fn backtrace(&self) -> Option<&Backtrace>

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

Returns a stack backtrace, if available, of where this error occurred.

fn description(&self) -> &str

👎 Deprecated since 1.42.0:

use the Display impl or to_string()

if let Err(e) = "xc".parse::<u32>() { // Print e itself, no need for description(). eprintln!("Error: {}", e); }

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

👎 Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

impl<T: StatusData> From<Status<T>> for Result<Status<T>, Status<T>>

fn from(s: Status<T>) -> Result<Status<T>, Status<T>>

Performs the conversion.

impl<T: PartialEq> PartialEq<Status<T>> for Status<T> where
    T: StatusData, 

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

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

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

This method tests for !=.

impl<T> StructuralEq for Status<T> where
    T: StatusData, 

impl<T> StructuralPartialEq for Status<T> where
    T: StatusData,