Skip to main content

NetworkStream

Enum NetworkStream 

Source
pub enum NetworkStream {
    Upgraded(UpgradedStream),
    Metadata(Arc<ConnectionMetadata>),
}
Expand description

A network stream handle exposed on responses for metadata access.

For upgraded connections (101/CONNECT), this provides full read/write/close/TLS access. For ordinary pooled connections, this provides read-only metadata — raw IO operations are not exposed while Hyper still owns the connection.

§Ordinal response limitation

Hyper’s legacy client pool retains ownership of socket connections for ordinary HTTP/1.1 and HTTP/2 responses. The pool does not expose per-response socket metadata, and raw IO operations would corrupt pool state. Therefore, NetworkStream::Metadata is currently only constructed for responses where socket metadata can be safely captured without interfering with the pool. For ordinary responses, network_stream on Response is None.

This is a documented bounded difference from httpcore, which owns its connections directly and can expose metadata on every response.

Variants§

§

Upgraded(UpgradedStream)

An upgraded stream with full IO access.

§

Metadata(Arc<ConnectionMetadata>)

Read-only metadata for an ordinary pooled connection.

Currently reserved for future use when socket metadata can be safely captured from Hyper’s connection pool. For ordinary responses, Response::network_stream() returns None.

Implementations§

Source§

impl NetworkStream

Source

pub fn metadata(&self) -> &Arc<ConnectionMetadata> ⓘ

Returns the connection metadata.

Source

pub fn is_upgraded(&self) -> bool

Returns true if this is an upgraded stream with IO access.

Source

pub fn as_upgraded(&self) -> Option<&UpgradedStream>

If this is an upgraded stream, returns a reference to it.

Source

pub fn as_upgraded_mut(&mut self) -> Option<&mut UpgradedStream>

If this is an upgraded stream, returns a mutable reference.

Source

pub fn into_upgraded(self) -> Option<UpgradedStream>

If this is an upgraded stream, consume and return it.

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