Struct RequestOptions 

pub struct RequestOptions {
    pub auth: Auth,
    pub extra_headers: HeaderMap,
}

Per-request authentication and header options.

Passed to every request method instead of a bare API key. Authentication headers (Auth) are applied first; RequestOptions::extra_headers are applied afterwards, so they can supply additional credentials of their own.

Fields

auth: Auth

How the request authenticates itself. Defaults to Auth::None.

extra_headers: HeaderMap

Additional headers attached verbatim to the request, e.g. OpenAI-Organization, Azure api-key or Anthropic anthropic-version.

Implementations

impl RequestOptions

pub fn new() -> Self

Creates options without authentication and without extra headers.

pub fn bearer(token: impl Into<String>) -> Self

Creates options authenticating with Authorization: Bearer <token>, the scheme used by OpenAI and most compatible providers.

pub fn with_header(self, name: &str, value: &str) -> Result<Self, OapiError>

Adds an extra header, e.g. api-key for Azure or x-api-key plus anthropic-version for Anthropic.

Header names and values are validated eagerly; use RequestOptions::extra_headers directly if you already hold typed HeaderName/HeaderValues.

Errors

Returns OapiError::InvalidHeader if the name or value is not a valid HTTP header.

Trait Implementations

impl Clone for RequestOptions

fn clone(&self) -> RequestOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RequestOptions

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

Formats the value using the given formatter.

impl Default for RequestOptions

fn default() -> RequestOptions

Returns the “default value” for a type.