Struct CallHeaders

pub struct CallHeaders { /* private fields */ }

Represents HTTP headers for an API call.

This struct manages HTTP headers using the same ParamValue pattern as query and path parameters, allowing for type-safe header handling with automatic OpenAPI schema generation.

Implementations

impl CallHeaders

pub fn new() -> Self

Creates a new empty CallHeaders instance.

pub fn add_header<T: ParameterValue>( self, name: impl Into<String>, value: impl Into<ParamValue<T>>, ) -> Self

Adds a header parameter to the collection.

Type Parameters

• T - The header value type, must implement Serialize, ToSchema, Debug, Send, Sync, and Clone

Arguments

• name - The header name (e.g., “Authorization”, “Content-Type”)
• value - The header value, either a direct value or wrapped in ParamValue

Example

use clawspec_core::CallHeaders;

let headers = CallHeaders::new()
    .add_header("Authorization", "Bearer token123")
    .add_header("X-Request-ID", "abc-123-def");

pub fn merge(self, other: Self) -> Self

Merges another CallHeaders instance into this one.

Headers from the other instance will override headers with the same name in this instance.

pub fn is_empty(&self) -> bool

Checks if the headers collection is empty.

pub fn len(&self) -> usize

Returns the number of headers.

Trait Implementations

impl Clone for CallHeaders

fn clone(&self) -> CallHeaders

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CallHeaders

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

Formats the value using the given formatter.

impl Default for CallHeaders

fn default() -> CallHeaders

Returns the “default value” for a type.