Skip to main content

ResponseValidationError

Struct ResponseValidationError 

Source
pub struct ResponseValidationError {
    pub errors: Vec<ValidationError>,
    pub response_content: Option<Value>,
    pub summary: Option<String>,
    pub debug_info: Option<DebugInfo>,
}
Expand description

Response validation error for internal failures (500 Internal Server Error).

This error type is used when a response fails to serialize or validate against the expected response model. Unlike ValidationErrors which indicates client errors (422), this represents a bug in the server code and returns a 500 status.

§When This Is Used

  • Response fails to serialize to JSON
  • Response doesn’t match the declared response_model
  • Internal data transformation fails

§Security Note

Error details and the original response content are logged server-side but are NOT exposed to clients (unless debug mode is explicitly enabled). This prevents leaking internal implementation details.

§Examples

use fastapi_core::error::{ResponseValidationError, ValidationError, loc};

// Serialization failure
let error = ResponseValidationError::serialization_failed(
    "failed to serialize field 'created_at': invalid date format"
);

// Response model validation failure
let error = ResponseValidationError::new()
    .with_error(ValidationError::missing(loc::response_field("user_id")))
    .with_response_content(serde_json::json!({"name": "Alice"}));

Fields§

§errors: Vec<ValidationError>

The validation errors that occurred.

§response_content: Option<Value>

The response content that failed validation (for logging only). This is NOT included in the response to clients.

§summary: Option<String>

A summary message for logging.

§debug_info: Option<DebugInfo>

Debug information (only included in response when debug mode is enabled).

Implementations§

Source§

impl ResponseValidationError

Source

pub fn new() -> Self

Create a new empty response validation error.

Source

pub fn serialization_failed(message: impl Into<String>) -> Self

Create a serialization failure error.

Use this when response serialization to JSON fails.

Source

pub fn model_validation_failed(message: impl Into<String>) -> Self

Create a response model validation failure error.

Use this when the response doesn’t match the declared response_model.

Source

pub fn with_error(self, error: ValidationError) -> Self

Add a validation error.

Source

pub fn with_errors( self, errors: impl IntoIterator<Item = ValidationError>, ) -> Self

Add multiple validation errors.

Source

pub fn with_response_content(self, content: Value) -> Self

Set the response content that failed validation.

This is logged server-side but NOT exposed to clients.

Source

pub fn with_summary(self, summary: impl Into<String>) -> Self

Set a summary message for logging.

Source

pub fn with_debug_info(self, debug_info: DebugInfo) -> Self

Add debug information.

This information will only be included in the response when debug mode is enabled (via enable_debug_mode()).

Source

pub fn is_empty(&self) -> bool

Check if there are no errors.

Source

pub fn len(&self) -> usize

Get the number of errors.

Source

pub fn iter(&self) -> impl Iterator<Item = &ValidationError>

Get an iterator over the errors.

Source

pub fn to_log_string(&self) -> String

Log the error details (for server-side logging).

This returns a formatted string suitable for logging that includes the error details and response content (if any).

Trait Implementations§

Source§

impl Clone for ResponseValidationError

Source§

fn clone(&self) -> ResponseValidationError

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ResponseValidationError

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for ResponseValidationError

Source§

fn default() -> ResponseValidationError

Returns the “default value” for a type. Read more
Source§

impl Display for ResponseValidationError

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Error for ResponseValidationError

1.30.0 · Source§

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

Returns the lower-level source of this error, if any. Read more
1.0.0 · Source§

fn description(&self) -> &str

👎Deprecated since 1.42.0: use the Display impl or to_string()
1.0.0 · Source§

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

👎Deprecated since 1.33.0: replaced by Error::source, which can support downcasting
Source§

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. Read more
Source§

impl IntoResponse for ResponseValidationError

Source§

fn into_response(self) -> Response

Convert into a response.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, _span: NoopSpan) -> Self

Instruments this future with a span (no-op when disabled).
Source§

fn in_current_span(self) -> Self

Instruments this future with the current span (no-op when disabled).
Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

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
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> ResponseProduces<T> for T