Struct hyper::server::conn::Connection[][src]

#[must_use = "futures do nothing unless polled"]pub struct Connection<T, S, E = Exec> where
    S: HttpService<Body>, 
{ /* fields omitted */ }

A future binding a connection with a Service.

Polling this future will drive HTTP forward.

Implementations

impl<I, B, S, E> Connection<I, S, E> where
    S: HttpService<Body, ResBody = B>,
    S::Error: Into<Box<dyn StdError + Send + Sync>>,
    I: AsyncRead + AsyncWrite + Unpin,
    B: HttpBody + 'static,
    B::Error: Into<Box<dyn StdError + Send + Sync>>,
    E: H2Exec<S::Future, B>, 
[src]

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

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>[src]

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 try_into_parts(self) -> Option<Parts<I, S>>[src]

Return the inner IO object, and additional information, if available.

This method will return a None 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,
    B: Unpin
[src]

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 fn without_shutdown(self) -> impl Future<Output = Result<Parts<I, S>>> where
    S: Unpin,
    S::Future: Unpin,
    B: Unpin
[src]

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.

pub fn with_upgrades(self) -> UpgradeableConnection<I, S, E> where
    I: Send
[src]

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<Body>, 
[src]

impl<I, B, S, E> Future for Connection<I, S, E> where
    S: HttpService<Body, ResBody = B>,
    S::Error: Into<Box<dyn StdError + Send + Sync>>,
    I: AsyncRead + AsyncWrite + Unpin + 'static,
    B: HttpBody + 'static,
    B::Error: Into<Box<dyn StdError + Send + Sync>>,
    E: H2Exec<S::Future, B>, 
[src]

type Output = Result<()>

The type of value produced on completion.

impl<'pin, T, S, E> Unpin for Connection<T, S, E> where
    S: HttpService<Body>,
    __Connection<'pin, T, S, E>: Unpin
[src]

Auto Trait Implementations

impl<T, S, E = Exec> !RefUnwindSafe for Connection<T, S, E>

impl<T, S, E> Send for Connection<T, S, E> where
    E: Send,
    S: Send,
    T: Send,
    <<S as HttpService<Body>>::ResBody as Body>::Data: Send,
    <S as HttpService<Body>>::Future: Send,
    <S as HttpService<Body>>::ResBody: Send

impl<T, S, E> Sync for Connection<T, S, E> where
    E: Sync,
    S: Sync,
    T: Sync,
    <<S as HttpService<Body>>::ResBody as Body>::Data: Send + Sync,
    <S as HttpService<Body>>::Future: Sync,
    <S as HttpService<Body>>::ResBody: Sync

impl<T, S, E = Exec> !UnwindSafe for Connection<T, S, E>

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized
[src]

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

impl<T> From<T> for T[src]

impl<T> FutureExt for T where
    T: Future + ?Sized
[src]

impl<T> Instrument for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

impl<F> IntoFuture for F where
    F: Future
[src]

type Output = <F as Future>::Output

🔬 This is a nightly-only experimental API. (into_future)

The output that the future will produce on completion.

type Future = F

🔬 This is a nightly-only experimental API. (into_future)

Which kind of future are we turning this into?

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<F, T, E> TryFuture for F where
    F: Future<Output = Result<T, E>> + ?Sized
[src]

type Ok = T

The type of successful values yielded by this future

type Error = E

The type of failures yielded by this future

impl<Fut> TryFutureExt for Fut where
    Fut: TryFuture + ?Sized
[src]

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.