Struct ApiResponse 

pub struct ApiResponse<T> {
    pub data: T,
    pub meta: ResponseMeta,
    pub links: Option<Links>,
}

Generic API response envelope.

Wraps any payload T with consistent metadata so all endpoints share the same top-level JSON shape. Use ApiResponse::builder for ergonomic construction.

Ergonomic access

ApiResponse<T> implements Deref<Target = T> so method and field access on the payload works transparently without .data:

use api_bones::response::ApiResponse;

let r: ApiResponse<String> = ApiResponse::builder("hello".to_string()).build();
assert_eq!(r.len(), 5);        // String::len via Deref
assert_eq!(&*r, "hello");      // explicit deref

To move the payload out and discard the envelope:

use api_bones::response::ApiResponse;

let r: ApiResponse<i32> = ApiResponse::builder(42).build();
let val: i32 = r.into_inner();
assert_eq!(val, 42);

To access envelope metadata alongside the payload:

use api_bones::response::ApiResponse;

let r: ApiResponse<i32> = ApiResponse::builder(1).build();
let _req_id = &r.meta.request_id;          // envelope field
let ApiResponse { data, meta, .. } = r;    // destructure

DerefMut is intentionally not implemented; mutate after calling into_inner().

Composing with PaginatedResponse

use api_bones::pagination::{PaginatedResponse, PaginationParams};
use api_bones::response::ApiResponse;

let params = PaginationParams::default();
let page = PaginatedResponse::new(vec![1i32, 2, 3], 10, &params);
let response = ApiResponse::builder(page).build();
assert_eq!(response.data.total_count, 10);

Fields

data: T

The primary payload.

meta: ResponseMeta

Request-level metadata.

links: Option<Links>

Optional hypermedia links.

Implementations

impl<T> ApiResponse<T>

pub fn builder(data: T) -> ApiResponseBuilder<T>

Begin building an ApiResponse with the given data payload.

pub fn into_inner(self) -> T

Consume the envelope and return the payload, discarding metadata.

Examples

use api_bones::response::ApiResponse;

let r: ApiResponse<i32> = ApiResponse::builder(42).build();
assert_eq!(r.into_inner(), 42);

Trait Implementations

impl<T: Clone> Clone for ApiResponse<T>

fn clone(&self) -> ApiResponse<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for ApiResponse<T>

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

Formats the value using the given formatter.

impl<T> Deref for ApiResponse<T>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<'de, T> Deserialize<'de> for ApiResponse<T>

where T: Deserialize<'de>,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T: PartialEq> PartialEq for ApiResponse<T>

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T> Serialize for ApiResponse<T>

where T: Serialize,

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<T> StructuralPartialEq for ApiResponse<T>