Struct Connection

pub struct Connection<T, B>
where
    T: AsyncRead + AsyncWrite,
    B: Body + Send + 'static + Unpin,
    <B as Body>::Data: Send + 'static,
    <B as Body>::Error: Into<Box<dyn Error + Sync + Send>>,
{ /* private fields */ }

A future that processes all HTTP state for the IO object.

In most cases, this should just be spawned into an executor, so that it can process incoming and outgoing messages, notice hangups, and the like.

Instances of this type are typically created via the handshake function

Implementations

impl<T, B> Connection<T, B>

where T: AsyncRead + AsyncWrite + Unpin, B: Body + Send + 'static + Unpin, <B as Body>::Data: Send + 'static, <B as Body>::Error: Into<Box<dyn Error + Sync + Send>>,

pub fn into_parts(self) -> Parts<T>

Return the inner IO object, and additional information.

Only works for HTTP/1 connections. HTTP/2 connections will panic.

pub fn poll_without_shutdown( &mut self, cx: &mut Context<'_>, ) -> Poll<Result<(), Error>>

Poll the connection for completion, but without calling shutdown on the underlying IO.

This is useful to allow running a connection while doing an HTTP upgrade. Once the upgrade is completed, the connection would be “done”, but it is not desired to actually shutdown the IO object. Instead you would take it back using into_parts.

Use poll_fn and try_ready! to work with this function; or use the without_shutdown wrapper.

pub async fn without_shutdown(self) -> Result<Parts<T>, Error>

Prevent shutdown of the underlying IO object at the end of service the request, instead run into_parts. This is a convenience wrapper over poll_without_shutdown.

impl<T, B> Connection<T, B>

where T: AsyncRead + AsyncWrite + Unpin + Send, B: Body + Send + 'static + Unpin, <B as Body>::Data: Send + 'static, <B as Body>::Error: Into<Box<dyn Error + Sync + Send>>,

pub fn with_upgrades(self) -> UpgradeableConnection<T, B>

Enable this connection to support higher-level HTTP upgrades.

See the upgrade module for more.

Trait Implementations

impl<T, B> Debug for Connection<T, B>

where T: AsyncRead + AsyncWrite + Debug, B: Body + Send + 'static + Unpin, <B as Body>::Data: Send + 'static, <B as Body>::Error: Into<Box<dyn Error + Sync + Send>>,

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

Formats the value using the given formatter.

impl<T, B> Future for Connection<T, B>

where T: AsyncRead + AsyncWrite + Unpin, B: Body + Send + 'static + Unpin, <B as Body>::Data: Send + 'static, <B as Body>::Error: Into<Box<dyn Error + Sync + Send>>,

type Output = Result<(), Error>

The type of value produced on completion.

fn poll( self: Pin<&mut Connection<T, B>>, cx: &mut Context<'_>, ) -> Poll<<Connection<T, B> as Future>::Output>

Attempts to resolve the future to a final value, registering the current task for wakeup if the value is not yet available.