Struct hyper::server::Server[−][src]

pub struct Server<I, S, E = Exec> { /* fields omitted */ }

A listening HTTP server that accepts connections in both HTTP1 and HTTP2 by default.

Server is a Future mapping a bound listener with a set of service handlers. It is built using the Builder, and the future completes when the server has been shutdown. It should be run by an Executor.

Implementations

`impl Server<I, ()>`[src]

`pub fn builder(incoming: I) -> Builder`[src]

Starts a Builder with the provided incoming stream.

`impl Server<AddrIncoming, ()>`[src]

`pub fn bind(addr: &SocketAddr) -> Builder<AddrIncoming>`[src]

Binds to the provided address, and returns a Builder.

Panics

This method will panic if binding to the address fails. For a method to bind to an address and return a Result, see Server::try_bind.

`pub fn try_bind(addr: &SocketAddr) -> Result<Builder<AddrIncoming>>`[src]

Tries to bind to the provided address, and returns a Builder.

`pub fn from_tcp( listener: StdTcpListener ) -> Result<Builder<AddrIncoming>, Error>`[src]

Create a new instance from a std::net::TcpListener instance.

`impl<S, E> Server<AddrIncoming, S, E>`[src]

`pub fn local_addr(&self) -> SocketAddr`[src]

Returns the local address that this server is bound to.

impl<I, IO, IE, S, E, B> Server<I, S, E> where I: Accept<Conn = IO, Error = IE>, IE: Into<Box<dyn StdError + Send + Sync>>, IO: AsyncRead + AsyncWrite + Unpin + Send + 'static, S: MakeServiceRef<IO, Body, ResBody = B>, S::Error: Into<Box<dyn StdError + Send + Sync>>, B: HttpBody + Send + Sync + 'static, B::Error: Into<Box<dyn StdError + Send + Sync>>, E: H2Exec<<S::Service as HttpService<Body>>::Future, B>, E: NewSvcExec<IO, S::Future, S::Service, E, GracefulWatcher>, [src]

`pub fn with_graceful_shutdown<F>(self, signal: F) -> Graceful<I, S, F, E> where F: Future<Output = ()>,` [src]

Prepares a server to handle graceful shutdown when the provided future completes.

Example

// Make a server from the previous examples...
let server = Server::bind(&([127, 0, 0, 1], 3000).into())
    .serve(make_service);

// Prepare some signal for when the server should start shutting down...
let (tx, rx) = tokio::sync::oneshot::channel::<()>();
let graceful = server
    .with_graceful_shutdown(async {
        rx.await.ok();
    });

// Await the `server` receiving the signal...
if let Err(e) = graceful.await {
    eprintln!("server error: {}", e);
}

// And later, trigger the signal by calling `tx.send(())`.
let _ = tx.send(());

Trait Implementations

`impl<I: Debug, S: Debug> Debug for Server<I, S>`[src]

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

impl<I, IO, IE, S, B, E> Future for Server<I, S, E> where I: Accept<Conn = IO, Error = IE>, IE: Into<Box<dyn StdError + Send + Sync>>, IO: AsyncRead + AsyncWrite + Unpin + Send + 'static, S: MakeServiceRef<IO, Body, ResBody = B>, S::Error: Into<Box<dyn StdError + Send + Sync>>, B: HttpBody + 'static, B::Error: Into<Box<dyn StdError + Send + Sync>>, E: H2Exec<<S::Service as HttpService<Body>>::Future, B>, E: NewSvcExec<IO, S::Future, S::Service, E, NoopWatcher>, [src]

`type Output = Result<()>`

The type of value produced on completion.

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

`impl<'pin, I, S, E> Unpin for Server<I, S, E> where __Server<'pin, I, S, E>: Unpin,` [src]

Auto Trait Implementations

`impl<I, S, E> RefUnwindSafe for Server<I, S, E> where E: RefUnwindSafe, I: RefUnwindSafe, S: RefUnwindSafe,`

`impl<I, S, E> Send for Server<I, S, E> where E: Send, I: Send, S: Send,`

`impl<I, S, E> Sync for Server<I, S, E> where E: Sync, I: Sync, S: Sync,`

`impl<I, S, E> UnwindSafe for Server<I, S, E> where E: UnwindSafe, I: UnwindSafe, S: UnwindSafe,`

Blanket Implementations

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

`pub fn type_id(&self) -> TypeId`[src]

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

`pub fn borrow(&self) -> &T`[src]

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

`pub fn borrow_mut(&mut self) -> &mut T`[src]

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

`pub fn from(t: T) -> T`[src]

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

`pub fn map<U, F>(self, f: F) -> Map<Self, F> where F: FnOnce(Self::Output) -> U,` [src]

`pub fn map_into(self) -> MapInto<Self, U> where Self::Output: Into,` [src]

`pub fn then<Fut, F>(self, f: F) -> Then<Self, Fut, F> where F: FnOnce(Self::Output) -> Fut, Fut: Future,` [src]

`pub fn left_future(self) -> Either<Self, B> where B: Future<Output = Self::Output>,` [src]

`pub fn right_future<A>(self) -> Either<A, Self> where A: Future<Output = Self::Output>,` [src]

`pub fn into_stream(self) -> IntoStream<Self>`[src]

`pub fn flatten(self) -> Flatten<Self> where Self::Output: Future,` [src]

`pub fn flatten_stream(self) -> FlattenStream<Self> where Self::Output: Stream,` [src]

`pub fn fuse(self) -> Fuse<Self>`[src]

`pub fn inspect<F>(self, f: F) -> Inspect<Self, F> where F: FnOnce(&Self::Output),` [src]

`pub fn catch_unwind(self) -> CatchUnwind<Self> where Self: UnwindSafe,` [src]

`pub fn shared(self) -> Shared<Self> where Self::Output: Clone,` [src]

`pub fn remote_handle(self) -> (Remote<Self>, RemoteHandle<Self::Output>)`[src]

`pub fn boxed<'a>( self ) -> Pin<Box<dyn Future<Output = Self::Output> + 'a + Send, Global>> where Self: Send + 'a,` [src]

`pub fn boxed_local<'a>( self ) -> Pin<Box<dyn Future<Output = Self::Output> + 'a, Global>> where Self: 'a,` [src]

`pub fn unit_error(self) -> UnitError<Self>`[src]

`pub fn never_error(self) -> NeverError<Self>`[src]

`pub fn poll_unpin(&mut self, cx: &mut Context<'_>) -> Poll<Self::Output> where Self: Unpin,` [src]

`pub fn now_or_never(self) -> Option<Self::Output>`[src]

`impl<T> Instrument for T`[src]

`pub fn instrument(self, span: Span) -> Instrumented<Self>`[src]

`pub fn in_current_span(self) -> Instrumented<Self>`[src]

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

`pub fn into(self) -> U`[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?

`pub fn into_future(self) -> <F as IntoFuture>::Future`[src]

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

`type Error = Infallible`

The type returned in the event of a conversion error.

`pub fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>`[src]

`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

`pub fn try_poll( self: Pin<&mut F>, cx: &mut Context<'_> ) -> Poll<<F as Future>::Output>`[src]

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

`pub fn flatten_sink<Item>(self) -> FlattenSink<Self, Self::Ok> where Self::Ok: Sink<Item>, <Self::Ok as Sink<Item>>::Error == Self::Error,` [src]

`pub fn map_ok<T, F>(self, f: F) -> MapOk<Self, F> where F: FnOnce(Self::Ok) -> T,` [src]

`pub fn map_ok_or_else<T, E, F>(self, e: E, f: F) -> MapOkOrElse<Self, F, E> where F: FnOnce(Self::Ok) -> T, E: FnOnce(Self::Error) -> T,` [src]

`pub fn map_err<E, F>(self, f: F) -> MapErr<Self, F> where F: FnOnce(Self::Error) -> E,` [src]

`pub fn err_into<E>(self) -> ErrInto<Self, E> where Self::Error: Into<E>,` [src]

`pub fn ok_into(self) -> OkInto<Self, U> where Self::Ok: Into,` [src]

`pub fn and_then<Fut, F>(self, f: F) -> AndThen<Self, Fut, F> where F: FnOnce(Self::Ok) -> Fut, Fut: TryFuture<Error = Self::Error>,` [src]

`pub fn or_else<Fut, F>(self, f: F) -> OrElse<Self, Fut, F> where F: FnOnce(Self::Error) -> Fut, Fut: TryFuture<Ok = Self::Ok>,` [src]

`pub fn inspect_ok<F>(self, f: F) -> InspectOk<Self, F> where F: FnOnce(&Self::Ok),` [src]

`pub fn inspect_err<F>(self, f: F) -> InspectErr<Self, F> where F: FnOnce(&Self::Error),` [src]

`pub fn try_flatten(self) -> TryFlatten<Self, Self::Ok> where Self::Ok: TryFuture, <Self::Ok as TryFuture>::Error == Self::Error,` [src]

`pub fn try_flatten_stream(self) -> TryFlattenStream<Self> where Self::Ok: TryStream, <Self::Ok as TryStream>::Error == Self::Error,` [src]

`pub fn unwrap_or_else<F>(self, f: F) -> UnwrapOrElse<Self, F> where F: FnOnce(Self::Error) -> Self::Ok,` [src]

`pub fn compat(self) -> Compat<Self> where Self: Unpin,` [src]

`pub fn into_future(self) -> IntoFuture<Self>`[src]

`pub fn try_poll_unpin( &mut self, cx: &mut Context<'_> ) -> Poll<Result<Self::Ok, Self::Error>> where Self: Unpin,` [src]

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

`type Error = >::Error`

The type returned in the event of a conversion error.

`pub fn try_into(self) -> Result<U, >::Error>`[src]

Struct hyper::server::Server⎘[−][src]

Implementations

impl<I> Server<I, ()>[src]

pub fn builder(incoming: I) -> Builder<I>[src]

impl Server<AddrIncoming, ()>[src]

pub fn bind(addr: &SocketAddr) -> Builder<AddrIncoming>[src]

Panics

pub fn try_bind(addr: &SocketAddr) -> Result<Builder<AddrIncoming>>[src]

pub fn from_tcp( listener: StdTcpListener) -> Result<Builder<AddrIncoming>, Error>[src]

impl<S, E> Server<AddrIncoming, S, E>[src]

pub fn local_addr(&self) -> SocketAddr[src]

pub fn with_graceful_shutdown<F>(self, signal: F) -> Graceful<I, S, F, E> where F: Future<Output = ()>, [src]

Example

Trait Implementations

impl<I: Debug, S: Debug> Debug for Server<I, S>[src]

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

type Output = Result<()>

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

impl<'pin, I, S, E> Unpin for Server<I, S, E> where __Server<'pin, I, S, E>: Unpin, [src]

Auto Trait Implementations

impl<I, S, E> RefUnwindSafe for Server<I, S, E> where E: RefUnwindSafe, I: RefUnwindSafe, S: RefUnwindSafe,

impl<I, S, E> Send for Server<I, S, E> where E: Send, I: Send, S: Send,

impl<I, S, E> Sync for Server<I, S, E> where E: Sync, I: Sync, S: Sync,

impl<I, S, E> UnwindSafe for Server<I, S, E> where E: UnwindSafe, I: UnwindSafe, S: UnwindSafe,

Blanket Implementations

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

pub fn type_id(&self) -> TypeId[src]

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

pub fn borrow(&self) -> &T[src]

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

pub fn borrow_mut(&mut self) -> &mut T[src]

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

pub fn from(t: T) -> T[src]

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

pub fn map<U, F>(self, f: F) -> Map<Self, F> where F: FnOnce(Self::Output) -> U, [src]

pub fn map_into<U>(self) -> MapInto<Self, U> where Self::Output: Into<U>, [src]

pub fn then<Fut, F>(self, f: F) -> Then<Self, Fut, F> where F: FnOnce(Self::Output) -> Fut, Fut: Future, [src]

pub fn left_future<B>(self) -> Either<Self, B> where B: Future<Output = Self::Output>, [src]

pub fn right_future<A>(self) -> Either<A, Self> where A: Future<Output = Self::Output>, [src]

pub fn into_stream(self) -> IntoStream<Self>[src]

pub fn flatten(self) -> Flatten<Self> where Self::Output: Future, [src]

pub fn flatten_stream(self) -> FlattenStream<Self> where Self::Output: Stream, [src]

pub fn fuse(self) -> Fuse<Self>[src]

pub fn inspect<F>(self, f: F) -> Inspect<Self, F> where F: FnOnce(&Self::Output), [src]

pub fn catch_unwind(self) -> CatchUnwind<Self> where Self: UnwindSafe, [src]

pub fn shared(self) -> Shared<Self> where Self::Output: Clone, [src]

pub fn remote_handle(self) -> (Remote<Self>, RemoteHandle<Self::Output>)[src]

pub fn boxed<'a>( self) -> Pin<Box<dyn Future<Output = Self::Output> + 'a + Send, Global>> where Self: Send + 'a, [src]

pub fn boxed_local<'a>( self) -> Pin<Box<dyn Future<Output = Self::Output> + 'a, Global>> where Self: 'a, [src]

pub fn unit_error(self) -> UnitError<Self>[src]

pub fn never_error(self) -> NeverError<Self>[src]

pub fn poll_unpin(&mut self, cx: &mut Context<'_>) -> Poll<Self::Output> where Self: Unpin, [src]

pub fn now_or_never(self) -> Option<Self::Output>[src]

impl<T> Instrument for T[src]

pub fn instrument(self, span: Span) -> Instrumented<Self>[src]

pub fn in_current_span(self) -> Instrumented<Self>[src]

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

pub fn into(self) -> U[src]

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

type Output = <F as Future>::Output

type Future = F

pub fn into_future(self) -> <F as IntoFuture>::Future[src]

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

type Error = Infallible

pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>[src]

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

type Ok = T

type Error = E

pub fn try_poll( self: Pin<&mut F>, cx: &mut Context<'_>) -> Poll<<F as Future>::Output>[src]

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

pub fn flatten_sink<Item>(self) -> FlattenSink<Self, Self::Ok> where Self::Ok: Sink<Item>, <Self::Ok as Sink<Item>>::Error == Self::Error, [src]

pub fn map_ok<T, F>(self, f: F) -> MapOk<Self, F> where F: FnOnce(Self::Ok) -> T, [src]

pub fn map_ok_or_else<T, E, F>(self, e: E, f: F) -> MapOkOrElse<Self, F, E> where F: FnOnce(Self::Ok) -> T, E: FnOnce(Self::Error) -> T, [src]

pub fn map_err<E, F>(self, f: F) -> MapErr<Self, F> where F: FnOnce(Self::Error) -> E, [src]

pub fn err_into<E>(self) -> ErrInto<Self, E> where Self::Error: Into<E>, [src]

pub fn ok_into<U>(self) -> OkInto<Self, U> where Self::Ok: Into<U>, [src]

pub fn and_then<Fut, F>(self, f: F) -> AndThen<Self, Fut, F> where F: FnOnce(Self::Ok) -> Fut, Fut: TryFuture<Error = Self::Error>, [src]

pub fn or_else<Fut, F>(self, f: F) -> OrElse<Self, Fut, F> where F: FnOnce(Self::Error) -> Fut, Fut: TryFuture<Ok = Self::Ok>, [src]

pub fn inspect_ok<F>(self, f: F) -> InspectOk<Self, F> where F: FnOnce(&Self::Ok), [src]

pub fn inspect_err<F>(self, f: F) -> InspectErr<Self, F> where F: FnOnce(&Self::Error), [src]