Struct hyper::server::Server

impl Server<I, ()>

pub fn builder(incoming: I) -> Builder

Starts a Builder with the provided incoming stream.

impl Server<AddrIncoming, ()>

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.

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

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

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

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

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

pub fn local_addr(&self) -> SocketAddr

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

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

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>

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

Formats the value using the given formatter. Read more

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> + NewSvcExec<IO, S::Future, S::Service, E, NoopWatcher>,

type Output = Result<(), Error>

The type of value produced on completion.

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

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 Twhere
T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

const: unstable · source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

const: unstable · source§

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

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

const: unstable · source§

fn from(t: T) -> T

Returns the argument unchanged.

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

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

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

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

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

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

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

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

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

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

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

fn into_stream(self) -> IntoStream<Self>where
Self: Sized,

Convert this future into a single element stream. Read more

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

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

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

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

fn fuse(self) -> Fuse<Self>where
Self: Sized,

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

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

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

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

Catches unwinding panics while polling the future. Read more

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

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

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

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

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

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

fn unit_error(self) -> UnitError<Self>where
Self: Sized,

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

fn never_error(self) -> NeverError<Self>where
Self: Sized,

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

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

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

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

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

impl<T> Instrument for T

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

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

fn in_current_span(self) -> Instrumented<Self>

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

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

const: unstable · source§

fn into(self) -> U

Calls U::from(self).

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

impl<F> IntoFuture for Fwhere
F: Future,

type Output = <F as Future>::Output

The output that the future will produce on completion.

type IntoFuture = F

Which kind of future are we turning this into?

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

Creates a future from a value. Read more

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

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source§

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

Performs the conversion.

impl<F, T, E> TryFuture for Fwhere
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

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

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

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

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

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,
 Self: Sized,

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

fn unwrap_or_else<F>(self, f: F) -> UnwrapOrElse<Self, F>where
Self: Sized,
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

fn into_future(self) -> IntoFuture<Self>where
Self: Sized,

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

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.

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

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source§

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

Performs the conversion.

impl<T> WithSubscriber for T

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