Struct axum::serve::WithGracefulShutdown

source ·
pub struct WithGracefulShutdown<M, S, F> { /* private fields */ }
Expand description

Serve future with graceful shutdown enabled.

Implementations§

source§

impl<M, S, F> WithGracefulShutdown<M, S, F>

source

pub fn tcp_nodelay(self, nodelay: bool) -> Self

Instructs the server to set the value of the TCP_NODELAY option on every accepted connection.

See also TcpStream::set_nodelay.

§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())
    .tcp_nodelay(true)
    .await
    .unwrap();

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

pub fn local_addr(&self) -> Result<SocketAddr>

Returns the local address this server is bound to.

Trait Implementations§

source§

impl<M, S, F> Debug for WithGracefulShutdown<M, S, F>
where M: Debug, S: Debug, F: Debug,

source§

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

Formats the value using the given formatter. Read more
source§

impl<M, S, F> IntoFuture for WithGracefulShutdown<M, S, F>
where M: for<'a> Service<IncomingStream<'a>, Error = Infallible, Response = S> + Send + 'static, for<'a> <M as Service<IncomingStream<'a>>>::Future: Send, S: Service<Request, Response = Response, Error = Infallible> + Clone + Send + 'static, S::Future: Send, F: Future<Output = ()> + Send + 'static,

§

type Output = Result<(), Error>

The output that the future will produce on completion.
§

type IntoFuture = ServeFuture

Which kind of future are we turning this into?
source§

fn into_future(self) -> Self::IntoFuture

Creates a future from a value. Read more

Auto Trait Implementations§

§

impl<M, S, F> !Freeze for WithGracefulShutdown<M, S, F>

§

impl<M, S, F> RefUnwindSafe for WithGracefulShutdown<M, S, F>

§

impl<M, S, F> Send for WithGracefulShutdown<M, S, F>
where M: Send, F: Send, S: Send,

§

impl<M, S, F> Sync for WithGracefulShutdown<M, S, F>
where M: Sync, F: Sync, S: Sync,

§

impl<M, S, F> Unpin for WithGracefulShutdown<M, S, F>
where M: Unpin, F: Unpin, S: Unpin,

§

impl<M, S, F> UnwindSafe for WithGracefulShutdown<M, S, F>
where M: UnwindSafe, F: 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<U> 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, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

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

Performs the conversion.
source§

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

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::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