Struct Serve

Source

pub struct Serve<L, M, S> { /* private fields */ }

Expand description

Future returned by serve.

Implementations§

Source §

impl<L, M, S> Serve<L, M, S>
where L: Listener,

Source

pub fn with_graceful_shutdown<F>( self, signal: F, ) -> WithGracefulShutdown<L, M, S, F>
where F: Future<Output = ()> + Send + 'static,

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

§Example

use axum::{Router, routing::get};

let router = Router::new().route("/", get(|| async { "Hello, World!" }));

let listener = tokio::net::TcpListener::bind("0.0.0.0:3000").await.unwrap();
axum::serve(listener, router)
    .with_graceful_shutdown(shutdown_signal())
    .await
    .unwrap();

async fn shutdown_signal() {
    // ...
}

Source

pub fn local_addr(&self) -> Result<<L as Listener>::Addr, Error>

Returns the local address this server is bound to.

Trait Implementations§

Source §

impl<L, M, S> Debug for Serve<L, M, S>
where L: Debug + 'static, M: Debug,

Source §

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

Formats the value using the given formatter. Read more

Source §

impl<L, M, S> IntoFuture for Serve<L, M, S>
where <L as Listener>::Addr: Debug, M: for<'a> Service<IncomingStream<'a, L>, Error = Infallible, Response = S> + Send + 'static, <M as Service<IncomingStream<'a, L>>>::Future: for<'a> Send, S: Service<Request<Body>, Response = Response<Body>, Error = Infallible> + Clone + Send + 'static, L: Listener, <S as Service<Request<Body>>>::Future: Send,

Source §

type Output = Result<(), Error>

The output that the future will produce on completion.

Source §

type IntoFuture = ServeFuture

Which kind of future are we turning this into?

Source §

fn into_future(self) -> <Serve<L, M, S> as IntoFuture>::IntoFuture

Creates a future from a value. Read more

Auto Trait Implementations§

§

impl<L, M, S> Freeze for Serve<L, M, S>
where L: Freeze, M: Freeze,

§

impl<L, M, S> RefUnwindSafe for Serve<L, M, S>
where L: RefUnwindSafe, M: RefUnwindSafe, S: RefUnwindSafe,

§

impl<L, M, S> UnwindSafe for Serve<L, M, S>
where L: UnwindSafe, M: UnwindSafe, S: UnwindSafe,

Blanket Implementations§

Source §

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

Source §

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

Source §

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

Source §

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

Source §

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

Source §

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

Mutably borrows from an owned value. Read more

Source §

impl<T> From<T> for T

Source §

fn from(t: T) -> T

Returns the argument unchanged.

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>,

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.

Source §

impl<T> IntoEither for T

Source §

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

Source §

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

Source §