Skip to main content

HttpStreamResponse

Struct HttpStreamResponse 

Source
pub struct HttpStreamResponse {
    pub status: StatusCode,
    pub headers: HeaderMap,
    pub url: Url,
    /* private fields */
}
Expand description

HTTP response metadata plus a lazy body stream (from crate::HttpClient::execute_stream).

Fields§

§status: StatusCode

HTTP status code of the first response line.

§headers: HeaderMap

Response headers available before consuming the body.

§url: Url

Effective URL after redirects.

Implementations§

Source§

impl HttpStreamResponse

Source

pub fn new( status: StatusCode, headers: HeaderMap, url: Url, stream: HttpByteStream, ) -> Self

Wraps status, headers, URL, and the byte stream.

§Parameters
  • status: HTTP status.
  • headers: Header map.
  • url: Final URL.
  • stream: Pinned body stream.
§Returns

New HttpStreamResponse.

Source

pub fn is_success(&self) -> bool

Same semantics as crate::HttpResponse::is_success.

§Returns

true when status is 2xx.

Source

pub fn into_stream(self) -> HttpByteStream

Destructures self, yielding the body stream for manual polling.

§Returns

The inner HttpByteStream.

Source

pub fn decode_events(self) -> SseEventStream

Decodes current stream body as SSE events (UTF-8 lines -> SSE frames).

§Returns

Stream yielding parsed SSE events.

§Errors

Each emitted item may contain:

Source

pub fn decode_events_with_limits( self, max_line_bytes: usize, max_frame_bytes: usize, ) -> SseEventStream

Decodes current stream body as SSE events with explicit line/frame size limits.

§Parameters
  • max_line_bytes: Maximum allowed bytes for one SSE line.
  • max_frame_bytes: Maximum allowed bytes for one SSE frame.
§Returns

Stream yielding parsed SSE events.

§Errors

Each emitted item may contain transport/read/protocol errors and limit violations.

Source

pub fn decode_json_chunks<T>( self, done_policy: DoneMarkerPolicy, ) -> SseChunkStream<T>
where T: DeserializeOwned + Send + 'static,

Decodes SSE data: payloads as JSON chunks with response defaults.

§Parameters
  • done_policy: Done marker policy (for example [DONE]).
§Type parameters
  • T: Target chunk type deserialized from each data: payload.
§Returns

Stream yielding crate::sse::SseChunk::Data and optional crate::sse::SseChunk::Done.

§Errors

The stream may emit transport/protocol errors. Malformed JSON behavior is controlled by the response default JSON mode (configured by crate::HttpClientOptions::sse_json_mode).

Source

pub fn decode_json_chunks_with_mode<T>( self, done_policy: DoneMarkerPolicy, mode: SseJsonMode, ) -> SseChunkStream<T>
where T: DeserializeOwned + Send + 'static,

Decodes SSE data: payloads as JSON chunks with configurable strictness.

§Parameters
  • done_policy: Done marker policy (for example [DONE]).
  • mode: JSON decoding strictness for malformed payloads.
§Type parameters
  • T: Target chunk type deserialized from each data: payload.
§Returns

Stream yielding crate::sse::SseChunk::Data and optional crate::sse::SseChunk::Done.

§Errors
  • transport/read errors from underlying stream;
  • protocol errors from SSE parsing;
  • in strict mode, crate::HttpError::sse_decode on malformed JSON payload.
Source

pub fn decode_json_chunks_with_mode_and_limits<T>( self, done_policy: DoneMarkerPolicy, mode: SseJsonMode, max_line_bytes: usize, max_frame_bytes: usize, ) -> SseChunkStream<T>
where T: DeserializeOwned + Send + 'static,

Decodes SSE data: payloads as JSON chunks with configurable strictness and limits.

§Parameters
  • done_policy: Done marker policy (for example [DONE]).
  • mode: JSON decoding strictness for malformed payloads.
  • max_line_bytes: Maximum allowed bytes for one SSE line.
  • max_frame_bytes: Maximum allowed bytes for one SSE frame.
§Type parameters
  • T: Target chunk type deserialized from each data: payload.
§Returns

Stream yielding crate::sse::SseChunk::Data and optional crate::sse::SseChunk::Done.

Trait Implementations§

Source§

impl Debug for HttpStreamResponse

Source§

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

Debug output includes status, headers, and URL; omits the stream body.

§Parameters
  • f: Formatter.
§Returns

std::fmt::Result.

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> 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: 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: 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, 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