Skip to main content

RequestOptions

Struct RequestOptions 

Source
pub struct RequestOptions { /* private fields */ }
Expand description

Per-request transport options applied on top of the operation’s own parameters.

Every generated client method takes a RequestOptions argument, letting you attach extra HTTP headers or authentication to a single request without re-instantiating the underlying client. Pass RequestOptions::default (or RequestOptions::new) when you have nothing to add.

The builder methods are chainable:

let options = openapi_trait::RequestOptions::new()
    .bearer_auth("token-123")
    .header("X-Request-Id", "abc");

Extra headers are applied after the operation’s declared headers, so a header set here is sent in addition to (and after) any same-named operation header. Authentication set via bearer_auth or basic_auth, by contrast, replaces the Authorization header from a configured security scheme, so per-request credentials deterministically win.

Implementations§

Source§

impl RequestOptions

Source

pub fn new() -> Self

Create an empty set of request options.

Source

pub fn header(self, name: impl Into<String>, value: impl Into<String>) -> Self

Add an extra header to the request.

Invalid header names or values are surfaced by reqwest when the request is sent, matching reqwest::RequestBuilder::header semantics.

Source

pub fn bearer_auth(self, token: impl Into<String>) -> Self

Attach an Authorization: Bearer <token> header to the request.

This replaces any Authorization header a configured security scheme would otherwise set, so the per-request token always wins. Calling it clears any credentials previously set via basic_auth.

Source

pub fn basic_auth( self, username: impl Into<String>, password: Option<String>, ) -> Self

Attach Authorization: Basic credentials to the request.

This replaces any Authorization header a configured security scheme would otherwise set, so the per-request credentials always win. Calling it clears any token previously set via bearer_auth.

Source

pub fn apply(self, request: RequestBuilder) -> RequestBuilder

Apply these options to a reqwest request builder.

Used by the generated reqwest-backed client implementation; you should not normally need to call it directly.

Trait Implementations§

Source§

impl Clone for RequestOptions

Source§

fn clone(&self) -> RequestOptions

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for RequestOptions

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for RequestOptions

Source§

fn default() -> RequestOptions

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more