Struct http_api_problem::ApiErrorBuilder

pub struct ApiErrorBuilder {
    pub status: StatusCode,
    pub title: Option<String>,
    pub message: Option<String>,
    pub type_url: Option<String>,
    pub instance: Option<String>,
    pub fields: HashMap<String, Value>,
    pub extensions: Extensions,
    pub source: Option<Box<dyn Error + Send + Sync + 'static>>,
}

Fields

status: StatusCode

The suggested status code for the server to be returned to the client

title: Option<String>

This is an optional title which can be used to create a valuable output for consumers.

message: Option<String>

A message that describes the error in a human readable form.

In an HttpApiProblem this becomes the detail in most cases.

type_url: Option<String>

A URL that points to a detailed description of the error.

instance: Option<String>

A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

fields: HashMap<String, Value>

Additional JSON encodable information. It is up to the server how and if it adds the given information.

extensions: Extensions

Typed extensions for carrying processable data server side

Can be used e.g. for middlewares

Extensions will not be part of an HttpApiProblem

source: Option<Box<dyn Error + Send + Sync + 'static>>

Implementations

impl ApiErrorBuilder

pub fn status<T: Into<StatusCode>>(self, status: T) -> Self

Set the StatusCode

pub fn try_status<T: TryInto<StatusCode>>(
    self,
    status: T
) -> Result<Self, InvalidStatusCode>where
    T::Error: Into<InvalidStatusCode>,

Try to set the StatusCode

Fails if the status argument can not be converted to a StatusCode

pub fn title<T: Display>(self, title: T) -> Self

This is an optional title which can be used to create a valuable output for consumers.

pub fn message<M: Display>(self, message: M) -> Self

A message that describes the error in a human readable form.

In an HttpApiProblem this becomes the detail in most cases.

pub fn type_url<U: Display>(self, type_url: U) -> Self

A URL that points to a detailed description of the error.

pub fn instance<T: Display>(self, instance: T) -> Self

Sets the instance

A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

pub fn field<T: Into<String>, V: Serialize>(self, name: T, value: V) -> Self

Adds a serializable field.

If the serialization fails nothing will be added. An already present field with the same name will be replaced.

pub fn with_fields<F>(self, f: F) -> Selfwhere
    F: FnOnce(HashMap<String, Value>) -> HashMap<String, Value>,

Modify the fields values from within a closure

pub fn extension<T: Send + Sync + 'static>(self, val: T) -> Self

Adds an extension value.

Existing values will be overwritten

Extensions will not be part of an HttpApiProblem

pub fn with_extensions<F>(self, f: F) -> Selfwhere
    F: FnOnce(Extensions) -> Extensions,

Modify the extension values from within a closure

Extensions will not be part of an HttpApiProblem

pub fn source<E: Error + Send + Sync + 'static>(self, source: E) -> Self

pub fn source_in_a_box<E: Into<Box<dyn Error + Send + Sync + 'static>>>(
    self,
    source: E
) -> Self

pub fn finish(self) -> ApiError

Build the ApiError

Trait Implementations

impl From<ApiErrorBuilder> for ApiError

fn from(builder: ApiErrorBuilder) -> Self

Converts to this type from the input type.