Struct Connection

pub struct Connection<T, S>
where
    S: HttpService<Incoming>,
{ /* private fields */ }

A Future representing an HTTP/1 connection, bound to a Service, returned from Builder::serve_connection.

To drive HTTP on this connection this future must be polled, typically with .await. If it isn’t polled, no progress will be made on this connection.

Implementations

impl<I, B, S> Connection<I, S>

where S: HttpService<Incoming, ResBody = B>, S::Error: Into<Box<dyn StdError + Send + Sync>>, I: Read + Write + Unpin, B: Body + 'static, B::Error: Into<Box<dyn StdError + Send + Sync>>,

pub fn graceful_shutdown(self: Pin<&mut Self>)

Start a graceful shutdown process for this connection.

This Connection should continue to be polled until shutdown can finish.

Note

This should only be called while the Connection future is still pending. If called after Connection::poll has resolved, this does nothing.

pub fn into_parts(self) -> Parts<I, S>

Return the inner IO object, and additional information.

If the IO object has been “rewound” the io will not contain those bytes rewound. This should only be called after poll_without_shutdown signals that the connection is “done”. Otherwise, it may not have finished flushing all necessary HTTP bytes.

Panics

This method will panic if this connection is using an h2 protocol.

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

where S: Unpin, S::Future: Unpin,

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.

pub fn without_shutdown(self) -> impl Future<Output = Result<Parts<I, S>>>

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.

Error

This errors if the underlying connection protocol is not HTTP/1.

pub fn with_upgrades(self) -> UpgradeableConnection<I, S>

where I: Send,

Enable this connection to support higher-level HTTP upgrades.

See the upgrade module for more.

Trait Implementations

impl<I, S> Debug for Connection<I, S>

where S: HttpService<Incoming>,

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

Formats the value using the given formatter.

impl<I, B, S> Future for Connection<I, S>

where S: HttpService<Incoming, ResBody = B>, S::Error: Into<Box<dyn StdError + Send + Sync>>, I: Read + Write + Unpin, B: Body + 'static, B::Error: Into<Box<dyn StdError + Send + Sync>>,

type Output = Result<(), Error>

The type of value produced on completion.

fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output>

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

impl<'__pin, T, S> Unpin for Connection<T, S>

where __Origin<'__pin, T, S>: Unpin, S: HttpService<IncomingBody>,