Struct http_api_problem::ApiErrorBuilder
source · [−]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 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.
source: Option<Box<dyn Error + Send + Sync + 'static>>
Implementations
sourceimpl ApiErrorBuilder
impl ApiErrorBuilder
sourcepub fn status<T: Into<StatusCode>>(self, status: T) -> Self
pub fn status<T: Into<StatusCode>>(self, status: T) -> Self
Set the StatusCode
sourcepub fn try_status<T: TryInto<StatusCode>>(
self,
status: T
) -> Result<Self, InvalidStatusCode> where
T::Error: Into<InvalidStatusCode>,
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
sourcepub fn title<T: Display>(self, title: T) -> Self
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.
sourcepub fn message<M: Display>(self, message: M) -> Self
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.
sourcepub fn type_url<U: Display>(self, type_url: U) -> Self
pub fn type_url<U: Display>(self, type_url: U) -> Self
A URL that points to a detailed description of the error.
sourcepub fn instance<T: Display>(self, instance: T) -> Self
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.
sourcepub fn field<T: Into<String>, V: Serialize>(self, name: T, value: V) -> Self
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 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
Trait Implementations
sourceimpl From<ApiErrorBuilder> for ApiError
impl From<ApiErrorBuilder> for ApiError
sourcefn from(builder: ApiErrorBuilder) -> Self
fn from(builder: ApiErrorBuilder) -> Self
Converts to this type from the input type.
Auto Trait Implementations
impl !RefUnwindSafe for ApiErrorBuilder
impl Send for ApiErrorBuilder
impl Sync for ApiErrorBuilder
impl Unpin for ApiErrorBuilder
impl !UnwindSafe for ApiErrorBuilder
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
impl<T> IntoCollection<T> for T
impl<T> IntoCollection<T> for T
fn into_collection<A>(self) -> SmallVec<A> where
A: Array<Item = T>,
fn into_collection<A>(self) -> SmallVec<A> where
A: Array<Item = T>,
Converts self
into a collection.
fn mapped<U, F, A>(self, f: F) -> SmallVec<A> where
F: FnMut(T) -> U,
A: Array<Item = U>,
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
fn vzip(self) -> V
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more