Struct ResponseEnvelope 

pub struct ResponseEnvelope<T, M> {
    pub data: T,
    pub meta: M,
}

A fully typed success-response envelope.

Both data and meta remain concrete generic schema arguments. Products should define DTOs for them rather than substituting serde_json::Value, so generated clients retain the complete response contract. A paginated response uses Vec<ItemDto> as T and a product-owned pagination metadata DTO as M.

Fields

data: T

The typed response payload.

meta: M

Typed response metadata, such as request ID and pagination cursor.

Implementations

impl<T, M> ResponseEnvelope<T, M>

pub const fn new(data: T, meta: M) -> ResponseEnvelope<T, M>

Creates a fully typed response envelope.

pub fn map<U>(self, map: impl FnOnce(T) -> U) -> ResponseEnvelope<U, M>

Maps the payload without weakening the metadata type.

Trait Implementations

impl<T, M> Clone for ResponseEnvelope<T, M>

where T: Clone, M: Clone,

fn clone(&self) -> ResponseEnvelope<T, M>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T, M> Debug for ResponseEnvelope<T, M>

where T: Debug, M: Debug,

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

Formats the value using the given formatter.

impl<'de, T, M> Deserialize<'de> for ResponseEnvelope<T, M>

where T: Deserialize<'de>, M: Deserialize<'de>,

fn deserialize<__D>( __deserializer: __D, ) -> Result<ResponseEnvelope<T, M>, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T, M> PartialEq for ResponseEnvelope<T, M>

where T: PartialEq, M: PartialEq,

fn eq(&self, other: &ResponseEnvelope<T, M>) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl<T, M> Serialize for ResponseEnvelope<T, M>

where T: Serialize, M: Serialize,

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<T, M> StructuralPartialEq for ResponseEnvelope<T, M>

where T: PartialEq, M: PartialEq,

impl<T, M> ToSchema for ResponseEnvelope<T, M>

where T: ToSchema, M: ToSchema,

fn name() -> Cow<'static, str>

Return name of the schema.

fn schemas(schemas: &mut Vec<(String, RefOr<Schema>)>)

Implement reference utoipa::openapi::schema::Schemas for this type.