Struct hyper::server::Server

source · [−]

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

Expand description

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

source

impl Server<I, ()>

source

pub fn builder(incoming: I) -> Builder

Starts a Builder with the provided incoming stream.

source

impl Server<AddrIncoming, ()>

source

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

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.

source

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

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

source

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

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

source

impl<S, E> Server<AddrIncoming, S, E>

source

pub fn local_addr(&self) -> SocketAddr

Returns the local address that this server is bound to.

source

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 + 'static,
 B::Error: Into<Box<dyn StdError + Send + Sync>>,
 E: ConnStreamExec<<S::Service as HttpService<Body>>::Future, B>,
 E: NewSvcExec<IO, S::Future, S::Service, E, GracefulWatcher>,

source

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

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

source

impl<I: Debug, S: Debug> Debug for Server<I, S>

source

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

Formats the value using the given formatter. Read more

source

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: ConnStreamExec<<S::Service as HttpService<Body>>::Future, B>,
 E: NewSvcExec<IO, S::Future, S::Service, E, NoopWatcher>,

type Output = Result<()>

The type of value produced on completion.

source

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

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

source

impl<'pin, I, S, E> Unpin for Server<I, S, E> where
Origin<'__pin, I, S, E>: Unpin,

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

source

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

source

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

pub fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

pub fn from(t: T) -> T

Returns the argument unchanged.

source

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

source

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

Map this future’s output to a different type, returning a new future of the resulting type. Read more

source

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

Map this future’s output to a different type, returning a new future of the resulting type. Read more

source

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

Chain on a computation for when a future finished, passing the result of the future to the provided closure f. Read more

source

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

Wrap this future in an Either future, making it the left-hand variant of that Either. Read more

source

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

Wrap this future in an Either future, making it the right-hand variant of that Either. Read more

source

fn into_stream(self) -> IntoStream<Self>

Convert this future into a single element stream. Read more

source

fn flatten(self) -> Flatten<Self> where
Self::Output: Future,

Flatten the execution of this future when the output of this future is itself another future. Read more

source

fn flatten_stream(self) -> FlattenStream<Self> where
Self::Output: Stream,

Flatten the execution of this future when the successful result of this future is a stream. Read more

source

fn fuse(self) -> Fuse<Self>

Fuse a future such that poll will never again be called once it has completed. This method can be used to turn any Future into a FusedFuture. Read more

source

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

Do something with the output of a future before passing it on. Read more

source

fn catch_unwind(self) -> CatchUnwind<Self> where
Self: UnwindSafe,

Catches unwinding panics while polling the future. Read more

source

fn shared(self) -> Shared<Self> where
Self::Output: Clone,

Create a cloneable handle to this future where all handles will resolve to the same result. Read more

source

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

Wrap the future in a Box, pinning it. Read more

source

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

Wrap the future in a Box, pinning it. Read more

source

fn unit_error(self) -> UnitError<Self>

Turns a Future<Output = T> into a TryFuture<Ok = T, Error = ()>. Read more

source

fn never_error(self) -> NeverError<Self>

Turns a Future<Output = T> into a TryFuture<Ok = T, Error = Never>. Read more

source

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

A convenience for calling Future::poll on Unpin future types.

source

fn now_or_never(self) -> Option<Self::Output>

Evaluates and consumes the future, returning the resulting output if the future is ready after the first call to Future::poll. Read more

source

impl<T> Instrument for T

source

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

source

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

source

impl<T, U> Into for T where
U: From<T>,

const: unstable · source

pub fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source

impl<F> IntoFuture for F where
F: Future,

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?

source

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

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

Creates a future from a value.

source

impl<T, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

source

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

type Ok = T

The type of successful values yielded by this future

type Error = E

The type of failures yielded by this future

source

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

Poll this TryFuture as if it were a Future. Read more

source

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

source

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

Maps this future’s success value to a different value. Read more

source

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,

Maps this future’s success value to a different value, and permits for error handling resulting in the same type. Read more

source

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

Maps this future’s error value to a different value. Read more

source

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

Maps this future’s Error to a new error type using the Into trait. Read more

source

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

Maps this future’s Ok to a new type using the Into trait. Read more

source

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

Executes another future after this one resolves successfully. The success value is passed to a closure to create this subsequent future. Read more

source

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

Executes another future if this one resolves to an error. The error value is passed to a closure to create this subsequent future. Read more

source

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

Do something with the success value of a future before passing it on. Read more

source

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

Do something with the error value of a future before passing it on. Read more

source

fn try_flatten(self) -> TryFlatten<Self, Self::Ok> where
Self::Ok: TryFuture,
<Self::Ok as TryFuture>::Error == Self::Error,

Flatten the execution of this future when the successful result of this future is another future. Read more

source

fn try_flatten_stream(self) -> TryFlattenStream<Self> where
Self::Ok: TryStream,
<Self::Ok as TryStream>::Error == Self::Error,

Flatten the execution of this future when the successful result of this future is a stream. Read more

source

fn unwrap_or_else<F>(self, f: F) -> UnwrapOrElse<Self, F> where
F: FnOnce(Self::Error) -> Self::Ok,

Unwraps this future’s output, producing a future with this future’s Ok type as its Output type. Read more

source

fn into_future(self) -> IntoFuture<Self>

Wraps a TryFuture into a type that implements Future. Read more

source

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

A convenience method for calling TryFuture::try_poll on Unpin future types. Read more

source

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

pub fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

source

impl<T> WithSubscriber for T

source

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

source

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more

Struct hyper::server::Server

Implementations

impl<I> Server<I, ()>

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

impl Server<AddrIncoming, ()>

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

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

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

impl<S, E> Server<AddrIncoming, S, E>

pub fn local_addr(&self) -> SocketAddr

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

Trait Implementations

impl<I: Debug, S: Debug> Debug for Server<I, S>

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

type Output = Result<()>

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

impl<'__pin, I, S, E> Unpin for Server<I, S, E> where __Origin<'__pin, I, S, E>: Unpin,

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,

pub fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

pub fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

pub fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

pub fn from(t: T) -> T

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

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

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

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

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

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

fn into_stream(self) -> IntoStream<Self>

fn flatten(self) -> Flatten<Self> where Self::Output: Future,

fn flatten_stream(self) -> FlattenStream<Self> where Self::Output: Stream,

fn fuse(self) -> Fuse<Self>

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

fn catch_unwind(self) -> CatchUnwind<Self> where Self: UnwindSafe,

fn shared(self) -> Shared<Self> where Self::Output: Clone,

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

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

fn unit_error(self) -> UnitError<Self>

fn never_error(self) -> NeverError<Self>

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

fn now_or_never(self) -> Option<Self::Output>

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

fn in_current_span(self) -> Instrumented<Self>

impl<T, U> Into<U> for T where U: From<T>,

pub fn into(self) -> U

impl<F> IntoFuture for F where F: Future,

type Output = <F as Future>::Output

type Future = F

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

impl<T, U> TryFrom<U> for T where U: Into<T>,

type Error = Infallible

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

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

type Ok = T

type Error = E

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

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

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

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,

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

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

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

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

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

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

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

fn try_flatten(self) -> TryFlatten<Self, Self::Ok> where Self::Ok: TryFuture, <Self::Ok as TryFuture>::Error == Self::Error,

fn try_flatten_stream(self) -> TryFlattenStream<Self> where Self::Ok: TryStream, <Self::Ok as TryStream>::Error == Self::Error,

fn unwrap_or_else<F>(self, f: F) -> UnwrapOrElse<Self, F> where F: FnOnce(Self::Error) -> Self::Ok,

fn into_future(self) -> IntoFuture<Self>

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

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

impl<'pin, I, S, E> Unpin for Server<I, S, E> where
Origin<'__pin, I, S, E>: Unpin,

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,

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

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

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

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

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

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

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

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

fn flatten(self) -> Flatten<Self> where
Self::Output: Future,

fn flatten_stream(self) -> FlattenStream<Self> where
Self::Output: Stream,

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

fn catch_unwind(self) -> CatchUnwind<Self> where
Self: UnwindSafe,

fn shared(self) -> Shared<Self> where
Self::Output: Clone,

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

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

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

impl<T, U> Into<U> for T where
U: From<T>,

impl<F> IntoFuture for F where
F: Future,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

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

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

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

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

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,

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

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

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

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

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

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

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

fn try_flatten(self) -> TryFlatten<Self, Self::Ok> where
Self::Ok: TryFuture,
<Self::Ok as TryFuture>::Error == Self::Error,

fn try_flatten_stream(self) -> TryFlattenStream<Self> where
Self::Ok: TryStream,
<Self::Ok as TryStream>::Error == Self::Error,

fn unwrap_or_else<F>(self, f: F) -> UnwrapOrElse<Self, F> where
F: FnOnce(Self::Error) -> Self::Ok,

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

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,