Skip to main content

ValidatedResponse

Struct ValidatedResponse 

Source
pub struct ValidatedResponse<T> {
    pub value: T,
    pub config: ResponseModelConfig,
}
Expand description

A validated response with its configuration.

This wraps a response value with its model configuration, ensuring the response is validated and filtered before sending.

§Examples

use fastapi_core::{ValidatedResponse, ResponseModelConfig};
use serde::Serialize;

#[derive(Serialize)]
struct User {
    id: i64,
    name: String,
    email: String,
    password_hash: String,
}

let user = User {
    id: 1,
    name: "Alice".to_string(),
    email: "alice@example.com".to_string(),
    password_hash: "secret123".to_string(),
};

// Create a validated response that excludes the password
let response = ValidatedResponse::new(user)
    .with_config(ResponseModelConfig::new()
        .exclude(["password_hash"].into_iter().map(String::from).collect()));

Fields§

§value: T

The response value.

§config: ResponseModelConfig

The serialization configuration.

Implementations§

Source§

impl<T> ValidatedResponse<T>

Source

pub fn new(value: T) -> Self

Create a new validated response.

Source

pub fn with_config(self, config: ResponseModelConfig) -> Self

Set the serialization configuration.

Trait Implementations§

Source§

impl<T: Debug> Debug for ValidatedResponse<T>

Source§

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

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

impl<T: Serialize + ResponseModel> IntoResponse for ValidatedResponse<T>

Source§

fn into_response(self) -> Response

Convert into a response.

Auto Trait Implementations§

§

impl<T> Freeze for ValidatedResponse<T>
where T: Freeze,

§

impl<T> RefUnwindSafe for ValidatedResponse<T>
where T: RefUnwindSafe,

§

impl<T> Send for ValidatedResponse<T>
where T: Send,

§

impl<T> Sync for ValidatedResponse<T>
where T: Sync,

§

impl<T> Unpin for ValidatedResponse<T>
where T: Unpin,

§

impl<T> UnwindSafe for ValidatedResponse<T>
where T: UnwindSafe,

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> 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, 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