Struct LinoHttpError 

pub struct LinoHttpError {
    pub status: u16,
    pub title: String,
    pub detail: Option<String>,
    pub type_uri: String,
    pub instance: Option<String>,
    pub headers: BTreeMap<String, String>,
    pub extensions: Vec<(String, LinoValue)>,
}

An HTTP error that carries problem details.

Returning one of these from a handler produces a conforming error response; the client returns the same shape when a server answers with 4xx or 5xx.

Fields

status: u16

HTTP status code.

title: String

Short, type-wide summary.

detail: Option<String>

Human readable explanation of this occurrence.

type_uri: String

Problem type URI.

instance: Option<String>

URI of this occurrence.

headers: BTreeMap<String, String>

Response headers to send with the error.

extensions: Vec<(String, LinoValue)>

Extra problem members.

Implementations

impl LinoHttpError

pub fn new(status: u16, detail: Option<&str>) -> Self

An error with a status and an optional detail, titled after the status.

Examples

use lino_rest_api::problem::LinoHttpError;

let error = LinoHttpError::new(404, Some("No task 7"));
assert_eq!(error.title, "Not Found");
assert!(error.type_uri.ends_with("not-found"));

pub fn with_title<S: Into<String>>(self, title: S) -> Self

The same error with another title, which also retitles the type URI.

pub fn with_type<S: Into<String>>(self, type_uri: S) -> Self

The same error with an explicit problem type URI.

pub fn with_instance<S: Into<String>>(self, instance: S) -> Self

The same error with the URI of this occurrence.

pub fn with_header<N: Into<String>, V: Into<String>>( self, name: N, value: V, ) -> Self

The same error with one more response header.

pub fn with_extension<S: Into<String>>(self, key: S, value: LinoValue) -> Self

The same error with one more problem member.

pub fn message(&self) -> &str

Human readable message: the detail when present, the title otherwise.

pub fn to_problem(&self, instance: Option<&str>) -> LinoValue

Render the error as the problem details object of the specification.

Trait Implementations

impl Clone for LinoHttpError

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 LinoHttpError

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

Formats the value using the given formatter.

impl Display for LinoHttpError

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

Formats the value using the given formatter.

impl Error for LinoHttpError

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 PartialEq for LinoHttpError

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for LinoHttpError