Skip to main content

HttpRequest

Struct HttpRequest 

Source
pub struct HttpRequest {
    pub url: String,
    pub headers: Vec<(String, String)>,
    pub abort_signal: Option<AbortSignal>,
    pub call_id: Option<String>,
    pub recording_context: Option<RecordingContext>,
    pub response_timeout: Option<Duration>,
    pub max_json_response_bytes: Option<usize>,
    pub validate_url: bool,
    pub trusted_origin: Option<String>,
    pub credentialed_origin: Option<String>,
}
Expand description

Metadata shared by post_json_to_api, post_form_data_to_api, post_to_api, and get_from_api. Method and body are fixed by the helper signature rather than supplied as runtime fields.

Fields§

§url: String§headers: Vec<(String, String)>§abort_signal: Option<AbortSignal>§call_id: Option<String>§recording_context: Option<RecordingContext>§response_timeout: Option<Duration>

Per-exchange whole-response hang guard. None uses the 30s default; a provider whose endpoint legitimately holds the connection longer (e.g. Replicate prefer: wait) declares its own bound here. Streaming exchanges are exempt regardless.

§max_json_response_bytes: Option<usize>

Per-request override of the successful-JSON-body size cap (default crate::read_response_with_size_limit::DEFAULT_MAX_JSON_RESPONSE_SIZE). Only consulted by crate::response_handler::create_json_response_handler; binary downloads keep the separate, larger DEFAULT_MAX_DOWNLOAD_SIZE bound regardless of this field.

§validate_url: bool

AI SDK validateUrl: set for URLs taken from provider responses (generated assets, polling and result URLs). The exchange then goes through the SSRF download guard — target and every DNS answer validated and pinned, redirects followed manually with each hop re-validated.

§trusted_origin: Option<String>

AI SDK trustedOrigin: a developer-configured origin (normally the provider’s base_url) whose same-origin URLs are exempt from the address blocklist, so self-hosted deployments serving assets from their own (possibly private) origin keep working. Reachability only — never about headers, and never derived from response data.

§credentialed_origin: Option<String>

AI SDK credentialedOrigin: caller headers (which may carry the provider API key) are sent only while the target is same-origin with this value — from the first request and on every redirect hop. None means the caller gates its own headers (e.g. BFL’s host allowlist).

Implementations§

Source§

impl HttpRequest

Source

pub fn new( url: impl Into<String>, headers: Vec<(String, String)>, options: &impl ExchangeContext, ) -> Self

A plain exchange that inherits the operation’s cancellation and recording context. Downloads of provider-supplied URLs set the guard fields explicitly instead.

Trait Implementations§

Source§

impl Clone for HttpRequest

Source§

fn clone(&self) -> Self

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 HttpRequest

Source§

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

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

impl Default for HttpRequest

Source§

fn default() -> Self

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

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 = !

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

fn try_from(value: U) -> Result<T, !>

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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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