Struct axum::handler::HandlerService
source · pub struct HandlerService<H, T, S, B> { /* private fields */ }
Expand description
An adapter that makes a Handler
into a Service
.
Created with Handler::with_state
or HandlerWithoutStateExt::into_service
.
Implementations§
source§impl<H, T, S, B> HandlerService<H, T, S, B>
impl<H, T, S, B> HandlerService<H, T, S, B>
sourcepub fn into_make_service(self) -> IntoMakeService<HandlerService<H, T, S, B>>
pub fn into_make_service(self) -> IntoMakeService<HandlerService<H, T, S, B>>
Convert the handler into a MakeService
.
This allows you to serve a single handler if you don’t need any routing:
use axum::{
Server,
handler::Handler,
extract::State,
http::{Uri, Method},
response::IntoResponse,
};
use std::net::SocketAddr;
#[derive(Clone)]
struct AppState {}
async fn handler(State(state): State<AppState>) {
// ...
}
let app = handler.with_state(AppState {});
Server::bind(&SocketAddr::from(([127, 0, 0, 1], 3000)))
.serve(app.into_make_service())
.await?;
sourcepub fn into_make_service_with_connect_info<C>(
self
) -> IntoMakeServiceWithConnectInfo<HandlerService<H, T, S, B>, C>
Available on crate feature tokio
only.
pub fn into_make_service_with_connect_info<C>( self ) -> IntoMakeServiceWithConnectInfo<HandlerService<H, T, S, B>, C>
tokio
only.Convert the handler into a MakeService
which stores information
about the incoming connection.
See Router::into_make_service_with_connect_info
for more details.
use axum::{
Server,
handler::Handler,
response::IntoResponse,
extract::{ConnectInfo, State},
};
use std::net::SocketAddr;
#[derive(Clone)]
struct AppState {};
async fn handler(
ConnectInfo(addr): ConnectInfo<SocketAddr>,
State(state): State<AppState>,
) -> String {
format!("Hello {}", addr)
}
let app = handler.with_state(AppState {});
Server::bind(&SocketAddr::from(([127, 0, 0, 1], 3000)))
.serve(app.into_make_service_with_connect_info::<SocketAddr>())
.await?;
Trait Implementations§
source§impl<H, T, S, B> Debug for HandlerService<H, T, S, B>
impl<H, T, S, B> Debug for HandlerService<H, T, S, B>
source§impl<H, T, S, B> Service<Request<B>> for HandlerService<H, T, S, B>where
H: Handler<T, S, B> + Clone + Send + 'static,
B: Send + 'static,
S: Clone + Send + Sync,
impl<H, T, S, B> Service<Request<B>> for HandlerService<H, T, S, B>where H: Handler<T, S, B> + Clone + Send + 'static, B: Send + 'static, S: Clone + Send + Sync,
§type Error = Infallible
type Error = Infallible
Errors produced by the service.
§type Future = IntoServiceFuture<<H as Handler<T, S, B>>::Future>
type Future = IntoServiceFuture<<H as Handler<T, S, B>>::Future>
The future response value.
Auto Trait Implementations§
impl<H, T, S, B> RefUnwindSafe for HandlerService<H, T, S, B>where H: RefUnwindSafe, S: RefUnwindSafe,
impl<H, T, S, B> Send for HandlerService<H, T, S, B>where H: Send, S: Send,
impl<H, T, S, B> Sync for HandlerService<H, T, S, B>where H: Sync, S: Sync,
impl<H, T, S, B> Unpin for HandlerService<H, T, S, B>where H: Unpin, S: Unpin,
impl<H, T, S, B> UnwindSafe for HandlerService<H, T, S, B>where H: UnwindSafe, S: UnwindSafe,
Blanket Implementations§
source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> PolicyExt for Twhere
T: ?Sized,
impl<T> PolicyExt for Twhere T: ?Sized,
source§impl<T, Request> ServiceExt<Request> for Twhere
T: Service<Request> + ?Sized,
impl<T, Request> ServiceExt<Request> for Twhere T: Service<Request> + ?Sized,
source§fn ready(&mut self) -> Ready<'_, Self, Request>where
Self: Sized,
fn ready(&mut self) -> Ready<'_, Self, Request>where Self: Sized,
Yields a mutable reference to the service when it is ready to accept a request.
source§fn ready_and(&mut self) -> Ready<'_, Self, Request>where
Self: Sized,
fn ready_and(&mut self) -> Ready<'_, Self, Request>where Self: Sized,
👎Deprecated since 0.4.6: please use the
ServiceExt::ready
method insteadYields a mutable reference to the service when it is ready to accept a request.
source§fn ready_oneshot(self) -> ReadyOneshot<Self, Request>where
Self: Sized,
fn ready_oneshot(self) -> ReadyOneshot<Self, Request>where Self: Sized,
Yields the service when it is ready to accept a request.
source§fn oneshot(self, req: Request) -> Oneshot<Self, Request>where
Self: Sized,
fn oneshot(self, req: Request) -> Oneshot<Self, Request>where Self: Sized,
Consume this
Service
, calling with the providing request once it is ready.source§fn call_all<S>(self, reqs: S) -> CallAll<Self, S>where
Self: Sized,
Self::Error: Into<Box<dyn Error + Sync + Send + 'static, Global>>,
S: Stream<Item = Request>,
fn call_all<S>(self, reqs: S) -> CallAll<Self, S>where Self: Sized, Self::Error: Into<Box<dyn Error + Sync + Send + 'static, Global>>, S: Stream<Item = Request>,
source§fn and_then<F>(self, f: F) -> AndThen<Self, F>where
Self: Sized,
F: Clone,
fn and_then<F>(self, f: F) -> AndThen<Self, F>where Self: Sized, F: Clone,
Executes a new future after this service’s future resolves. This does
not alter the behaviour of the
poll_ready
method. Read moresource§fn map_response<F, Response>(self, f: F) -> MapResponse<Self, F>where
Self: Sized,
F: FnOnce(Self::Response) -> Response + Clone,
fn map_response<F, Response>(self, f: F) -> MapResponse<Self, F>where Self: Sized, F: FnOnce(Self::Response) -> Response + Clone,
Maps this service’s response value to a different value. This does not
alter the behaviour of the
poll_ready
method. Read moresource§fn map_err<F, Error>(self, f: F) -> MapErr<Self, F>where
Self: Sized,
F: FnOnce(Self::Error) -> Error + Clone,
fn map_err<F, Error>(self, f: F) -> MapErr<Self, F>where Self: Sized, F: FnOnce(Self::Error) -> Error + Clone,
Maps this service’s error value to a different value. This does not
alter the behaviour of the
poll_ready
method. Read moresource§fn map_result<F, Response, Error>(self, f: F) -> MapResult<Self, F>where
Self: Sized,
Error: From<Self::Error>,
F: FnOnce(Result<Self::Response, Self::Error>) -> Result<Response, Error> + Clone,
fn map_result<F, Response, Error>(self, f: F) -> MapResult<Self, F>where Self: Sized, Error: From<Self::Error>, F: FnOnce(Result<Self::Response, Self::Error>) -> Result<Response, Error> + Clone,
Maps this service’s result type (
Result<Self::Response, Self::Error>
)
to a different value, regardless of whether the future succeeds or
fails. Read moresource§fn map_request<F, NewRequest>(self, f: F) -> MapRequest<Self, F>where
Self: Sized,
F: FnMut(NewRequest) -> Request,
fn map_request<F, NewRequest>(self, f: F) -> MapRequest<Self, F>where Self: Sized, F: FnMut(NewRequest) -> Request,
Composes a function in front of the service. Read more
source§fn filter<F, NewRequest>(self, filter: F) -> Filter<Self, F>where
Self: Sized,
F: Predicate<NewRequest>,
fn filter<F, NewRequest>(self, filter: F) -> Filter<Self, F>where Self: Sized, F: Predicate<NewRequest>,
Available on crate feature
filter
only.source§fn filter_async<F, NewRequest>(self, filter: F) -> AsyncFilter<Self, F>where
Self: Sized,
F: AsyncPredicate<NewRequest>,
fn filter_async<F, NewRequest>(self, filter: F) -> AsyncFilter<Self, F>where Self: Sized, F: AsyncPredicate<NewRequest>,
Available on crate feature
filter
only.Composes this service with an
AsyncFilter
that conditionally accepts or
rejects requests based on an [async predicate]. Read moresource§fn then<F, Response, Error, Fut>(self, f: F) -> Then<Self, F>where
Self: Sized,
Error: From<Self::Error>,
F: FnOnce(Result<Self::Response, Self::Error>) -> Fut + Clone,
Fut: Future<Output = Result<Response, Error>>,
fn then<F, Response, Error, Fut>(self, f: F) -> Then<Self, F>where Self: Sized, Error: From<Self::Error>, F: FnOnce(Result<Self::Response, Self::Error>) -> Fut + Clone, Fut: Future<Output = Result<Response, Error>>,
Composes an asynchronous function after this service. Read more
source§fn map_future<F, Fut, Response, Error>(self, f: F) -> MapFuture<Self, F>where
Self: Sized,
F: FnMut(Self::Future) -> Fut,
Error: From<Self::Error>,
Fut: Future<Output = Result<Response, Error>>,
fn map_future<F, Fut, Response, Error>(self, f: F) -> MapFuture<Self, F>where Self: Sized, F: FnMut(Self::Future) -> Fut, Error: From<Self::Error>, Fut: Future<Output = Result<Response, Error>>,
Composes a function that transforms futures produced by the service. Read more