Skip to main content

ValidationErrors

Struct ValidationErrors 

Source
pub struct ValidationErrors {
    pub errors: Vec<ValidationError>,
    pub body: Option<Value>,
    pub debug_info: Option<DebugInfo>,
}
Expand description

Collection of validation errors (422 Unprocessable Entity response).

This collects multiple validation errors from extractors and validators, producing a FastAPI-compatible error response format.

§Examples

use fastapi_core::error::{ValidationErrors, ValidationError, loc, error_types};
use serde_json::json;

let mut errors = ValidationErrors::new();

// Add multiple errors
errors.push(ValidationError::missing(loc::query("q")));
errors.push(ValidationError::string_too_short(loc::body_field("name"), 3)
    .with_input(json!("ab")));

// Check and convert
if !errors.is_empty() {
    let json = errors.to_json();
    assert!(json.contains("missing"));
}

Fields§

§errors: Vec<ValidationError>

The collected errors.

§body: Option<Value>

The original input body (if available).

§debug_info: Option<DebugInfo>

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

Implementations§

Source§

impl ValidationErrors

Source

pub fn new() -> Self

Create empty validation errors.

Source

pub fn single(error: ValidationError) -> Self

Create from a single error.

Source

pub fn from_errors(errors: Vec<ValidationError>) -> Self

Create from multiple errors.

Source

pub fn push(&mut self, error: ValidationError)

Add an error.

Source

pub fn extend(&mut self, errors: impl IntoIterator<Item = ValidationError>)

Add multiple errors.

Source

pub fn with_body(self, body: Value) -> Self

Set the original body that failed validation.

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 any 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_json(&self) -> String

Convert to FastAPI-compatible JSON string.

Source

pub fn to_json_bytes(&self) -> Vec<u8>

Convert to JSON bytes.

Source

pub fn merge(&mut self, other: ValidationErrors)

Merge another ValidationErrors into this one.

Source

pub fn with_loc_prefix(self, prefix: Vec<LocItem>) -> Self

Add a prefix to all error locations.

Trait Implementations§

Source§

impl Clone for ValidationErrors

Source§

fn clone(&self) -> ValidationErrors

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 ValidationErrors

Source§

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

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

impl Default for ValidationErrors

Source§

fn default() -> ValidationErrors

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

impl Display for ValidationErrors

Source§

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

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

impl Error for ValidationErrors

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 Extend<ValidationError> for ValidationErrors

Source§

fn extend<T: IntoIterator<Item = ValidationError>>(&mut self, iter: T)

Extends a collection with the contents of an iterator. Read more
Source§

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)
Extends a collection with exactly one element.
Source§

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)
Reserves capacity in a collection for the given number of additional elements. Read more
Source§

impl FromIterator<ValidationError> for ValidationErrors

Source§

fn from_iter<T: IntoIterator<Item = ValidationError>>(iter: T) -> Self

Creates a value from an iterator. Read more
Source§

impl<'a> IntoIterator for &'a ValidationErrors

Source§

type Item = &'a ValidationError

The type of the elements being iterated over.
Source§

type IntoIter = Iter<'a, ValidationError>

Which kind of iterator are we turning this into?
Source§

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value. Read more
Source§

impl IntoIterator for ValidationErrors

Source§

type Item = ValidationError

The type of the elements being iterated over.
Source§

type IntoIter = IntoIter<ValidationError>

Which kind of iterator are we turning this into?
Source§

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value. Read more
Source§

impl IntoResponse for ValidationErrors

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