Struct ResponseMeta 

pub struct ResponseMeta {
    pub request_id: Option<String>,
    pub timestamp: Option<Timestamp>,
    pub version: Option<String>,
}

Metadata attached to every ApiResponse.

All fields are optional to keep construction ergonomic. Consumers that do not need a field simply omit it; it will be skipped in serialization.

Fields

request_id: Option<String>

Unique identifier for the originating HTTP request.

Useful for correlating logs and distributed traces.

timestamp: Option<Timestamp>

Server-side timestamp when the response was generated (RFC 3339).

version: Option<String>

API or service version string.

Implementations

impl ResponseMeta

pub fn new() -> Self

Create an empty ResponseMeta.

Examples

use api_bones::response::ResponseMeta;

let meta = ResponseMeta::new();
assert!(meta.request_id.is_none());
assert!(meta.version.is_none());

pub fn request_id(self, id: impl Into<String>) -> Self

Set the request_id field (builder-style).

Examples

use api_bones::response::ResponseMeta;

let meta = ResponseMeta::new().request_id("req-001");
assert_eq!(meta.request_id.as_deref(), Some("req-001"));

pub fn timestamp(self, ts: Timestamp) -> Self

Set the timestamp field (builder-style).

pub fn version(self, v: impl Into<String>) -> Self

Set the version field (builder-style).

Examples

use api_bones::response::ResponseMeta;

let meta = ResponseMeta::new().version("1.4.0");
assert_eq!(meta.version.as_deref(), Some("1.4.0"));

Trait Implementations

impl Clone for ResponseMeta

fn clone(&self) -> ResponseMeta

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ResponseMeta

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

Formats the value using the given formatter.

impl Default for ResponseMeta

fn default() -> ResponseMeta

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ResponseMeta

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ResponseMeta

fn eq(&self, other: &ResponseMeta) -> 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 Serialize for ResponseMeta

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ResponseMeta