Struct hyper::server::conn::Connection
source · pub struct Connection<T, S, E = Exec>where
S: HttpService<Body>,{ /* private fields */ }
Expand description
A future binding a connection with a Service.
Polling this future will drive HTTP forward.
Implementations§
source§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: ConnStreamExec<S::Future, B>,
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: ConnStreamExec<S::Future, B>,
sourcepub fn graceful_shutdown(self: Pin<&mut Self>)
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.
sourcepub fn into_parts(self) -> Parts<I, S>
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.
sourcepub fn try_into_parts(self) -> Option<Parts<I, S>>
pub fn try_into_parts(self) -> Option<Parts<I, S>>
Return the inner IO object, and additional information, if available.
This method will return a None
if this connection is using an h2 protocol.
sourcepub fn poll_without_shutdown(
&mut self,
cx: &mut Context<'_>
) -> Poll<Result<()>>where
S: Unpin,
S::Future: Unpin,
B: Unpin,
pub fn poll_without_shutdown( &mut self, cx: &mut Context<'_> ) -> Poll<Result<()>>where S: Unpin, S::Future: Unpin, B: 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
.
sourcepub fn without_shutdown(self) -> impl Future<Output = Result<Parts<I, S>>>where
S: Unpin,
S::Future: Unpin,
B: Unpin,
pub fn without_shutdown(self) -> impl Future<Output = Result<Parts<I, S>>>where S: Unpin, S::Future: Unpin, B: Unpin,
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.
sourcepub fn with_upgrades(self) -> UpgradeableConnection<I, S, E>where
I: Send,
pub fn with_upgrades(self) -> UpgradeableConnection<I, S, E>where I: Send,
Enable this connection to support higher-level HTTP upgrades.
See the upgrade
module for more.
Trait Implementations§
source§impl<I, S> Debug for Connection<I, S>where
S: HttpService<Body>,
impl<I, S> Debug for Connection<I, S>where S: HttpService<Body>,
source§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: ConnStreamExec<S::Future, B>,
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: ConnStreamExec<S::Future, B>,
impl<'__pin, T, S, E> Unpin for Connection<T, S, E>where __Origin<'__pin, T, S, E>: Unpin, S: HttpService<Body>,
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§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> FutureExt for Twhere
T: Future + ?Sized,
impl<T> FutureExt for Twhere T: Future + ?Sized,
source§fn map<U, F>(self, f: F) -> Map<Self, F>where
F: FnOnce(Self::Output) -> U,
Self: Sized,
fn map<U, F>(self, f: F) -> Map<Self, F>where F: FnOnce(Self::Output) -> U, Self: Sized,
source§fn map_into<U>(self) -> MapInto<Self, U>where
Self::Output: Into<U>,
Self: Sized,
fn map_into<U>(self) -> MapInto<Self, U>where Self::Output: Into<U>, Self: Sized,
source§fn then<Fut, F>(self, f: F) -> Then<Self, Fut, F>where
F: FnOnce(Self::Output) -> Fut,
Fut: Future,
Self: Sized,
fn then<Fut, F>(self, f: F) -> Then<Self, Fut, F>where F: FnOnce(Self::Output) -> Fut, Fut: Future, Self: Sized,
f
. Read moresource§fn left_future<B>(self) -> Either<Self, B>where
B: Future<Output = Self::Output>,
Self: Sized,
fn left_future<B>(self) -> Either<Self, B>where B: Future<Output = Self::Output>, Self: Sized,
source§fn right_future<A>(self) -> Either<A, Self>where
A: Future<Output = Self::Output>,
Self: Sized,
fn right_future<A>(self) -> Either<A, Self>where A: Future<Output = Self::Output>, Self: Sized,
source§fn into_stream(self) -> IntoStream<Self>where
Self: Sized,
fn into_stream(self) -> IntoStream<Self>where Self: Sized,
source§fn flatten(self) -> Flatten<Self>where
Self::Output: Future,
Self: Sized,
fn flatten(self) -> Flatten<Self>where Self::Output: Future, Self: Sized,
source§fn flatten_stream(self) -> FlattenStream<Self>where
Self::Output: Stream,
Self: Sized,
fn flatten_stream(self) -> FlattenStream<Self>where Self::Output: Stream, Self: Sized,
source§fn fuse(self) -> Fuse<Self>where
Self: Sized,
fn fuse(self) -> Fuse<Self>where Self: Sized,
poll
will never again be called once it has
completed. This method can be used to turn any Future
into a
FusedFuture
. Read moresource§fn inspect<F>(self, f: F) -> Inspect<Self, F>where
F: FnOnce(&Self::Output),
Self: Sized,
fn inspect<F>(self, f: F) -> Inspect<Self, F>where F: FnOnce(&Self::Output), Self: Sized,
source§fn catch_unwind(self) -> CatchUnwind<Self>where
Self: Sized + UnwindSafe,
fn catch_unwind(self) -> CatchUnwind<Self>where Self: Sized + UnwindSafe,
source§fn remote_handle(self) -> (Remote<Self>, RemoteHandle<Self::Output>)where
Self: Sized,
fn remote_handle(self) -> (Remote<Self>, RemoteHandle<Self::Output>)where Self: Sized,
()
on completion and sends
its output to another future on a separate task. Read moresource§fn boxed<'a>(
self
) -> Pin<Box<dyn Future<Output = Self::Output> + Send + 'a, Global>>where
Self: Sized + Send + 'a,
fn boxed<'a>( self ) -> Pin<Box<dyn Future<Output = Self::Output> + Send + 'a, Global>>where Self: Sized + Send + 'a,
source§fn boxed_local<'a>(
self
) -> Pin<Box<dyn Future<Output = Self::Output> + 'a, Global>>where
Self: Sized + 'a,
fn boxed_local<'a>( self ) -> Pin<Box<dyn Future<Output = Self::Output> + 'a, Global>>where Self: Sized + 'a,
source§fn unit_error(self) -> UnitError<Self>where
Self: Sized,
fn unit_error(self) -> UnitError<Self>where Self: Sized,
Future<Output = T>
into a
TryFuture<Ok = T, Error = ()
>.source§fn never_error(self) -> NeverError<Self>where
Self: Sized,
fn never_error(self) -> NeverError<Self>where Self: Sized,
Future<Output = T>
into a
TryFuture<Ok = T, Error = Never
>.