Struct actix_http::HttpService

pub struct HttpService<T, S, B, X = ExpectHandler, U = UpgradeHandler> { /* private fields */ }

A ServiceFactory for HTTP/1.1 and HTTP/2 connections.

Use build to begin constructing service. Also see HttpServiceBuilder.

Automatic HTTP Version Selection

There are two ways to select the HTTP version of an incoming connection:

• One is to rely on the ALPN information that is provided when using a TLS (HTTPS); both versions are supported automatically when using either of the .rustls() or .openssl() finalizing methods.
• The other is to read the first few bytes of the TCP stream. This is the only viable approach for supporting H2C, which allows the HTTP/2 protocol to work over plaintext connections. Use the .tcp_auto_h2c() finalizing method to enable this behavior.

Examples

use actix_http::{HttpService, Request, Response, StatusCode};

// this service would constructed in an actix_server::Server

HttpService::build()
    // the builder finalizing method, other finalizers would not return an `HttpService`
    .finish(|_req: Request| async move {
        Ok::<_, Infallible>(
            Response::build(StatusCode::OK).body("Hello!")
        )
    })
    // the service finalizing method method
    // you can use `.tcp_auto_h2c()`, `.rustls()`, or `.openssl()` instead of `.tcp()`
    .tcp();

Implementations

impl<S, B, X, U> HttpService<TlsStream<TcpStream>, S, B, X, U>where
    S: ServiceFactory<Request, Config = ()>,
    S::Future: 'static,
    S::Error: Into<Response<BoxBody>> + 'static,
    S::InitError: Debug,
    S::Response: Into<Response<B>> + 'static,
    <S::Service as Service<Request>>::Future: 'static,
    B: MessageBody + 'static,
    X: ServiceFactory<Request, Config = (), Response = Request>,
    X::Future: 'static,
    X::Error: Into<Response<BoxBody>>,
    X::InitError: Debug,
    U: ServiceFactory<(Request, Framed<TlsStream<TcpStream>, Codec>), Config = (), Response = ()>,
    U::Future: 'static,
    U::Error: Display + Into<Response<BoxBody>>,
    U::InitError: Debug,

pub fn openssl(
    self,
    acceptor: SslAcceptor
) -> impl ServiceFactory<TcpStream, Config = (), Response = (), Error = TlsError<SslError, DispatchError>, InitError = ()>

Create OpenSSL based service.

pub fn openssl_with_config(
    self,
    acceptor: SslAcceptor,
    tls_acceptor_config: TlsAcceptorConfig
) -> impl ServiceFactory<TcpStream, Config = (), Response = (), Error = TlsError<SslError, DispatchError>, InitError = ()>

Create OpenSSL based service with custom TLS acceptor configuration.

impl<S, B, X, U> HttpService<TlsStream<TcpStream>, S, B, X, U>where
    S: ServiceFactory<Request, Config = ()>,
    S::Future: 'static,
    S::Error: Into<Response<BoxBody>> + 'static,
    S::InitError: Debug,
    S::Response: Into<Response<B>> + 'static,
    <S::Service as Service<Request>>::Future: 'static,
    B: MessageBody + 'static,
    X: ServiceFactory<Request, Config = (), Response = Request>,
    X::Future: 'static,
    X::Error: Into<Response<BoxBody>>,
    X::InitError: Debug,
    U: ServiceFactory<(Request, Framed<TlsStream<TcpStream>, Codec>), Config = (), Response = ()>,
    U::Future: 'static,
    U::Error: Display + Into<Response<BoxBody>>,
    U::InitError: Debug,

pub fn rustls(
    self,
    config: ServerConfig
) -> impl ServiceFactory<TcpStream, Config = (), Response = (), Error = TlsError<Error, DispatchError>, InitError = ()>

Create Rustls based service.

pub fn rustls_with_config(
    self,
    config: ServerConfig,
    tls_acceptor_config: TlsAcceptorConfig
) -> impl ServiceFactory<TcpStream, Config = (), Response = (), Error = TlsError<Error, DispatchError>, InitError = ()>

Create Rustls based service with custom TLS acceptor configuration.

impl<T, S, B> HttpService<T, S, B>where
    S: ServiceFactory<Request, Config = ()>,
    S::Error: Into<Response<BoxBody>> + 'static,
    S::InitError: Debug,
    S::Response: Into<Response<B>> + 'static,
    <S::Service as Service<Request>>::Future: 'static,
    B: MessageBody + 'static,

pub fn build() -> HttpServiceBuilder<T, S>

Constructs builder for HttpService instance.

impl<T, S, B> HttpService<T, S, B>where
    S: ServiceFactory<Request, Config = ()>,
    S::Error: Into<Response<BoxBody>> + 'static,
    S::InitError: Debug,
    S::Response: Into<Response<B>> + 'static,
    <S::Service as Service<Request>>::Future: 'static,
    B: MessageBody + 'static,

pub fn new<F: IntoServiceFactory<S, Request>>(service: F) -> Self

Constructs new HttpService instance from service with default config.

impl<T, S, B, X, U> HttpService<T, S, B, X, U>where
    S: ServiceFactory<Request, Config = ()>,
    S::Error: Into<Response<BoxBody>> + 'static,
    S::InitError: Debug,
    S::Response: Into<Response<B>> + 'static,
    <S::Service as Service<Request>>::Future: 'static,
    B: MessageBody,

pub fn expect<X1>(self, expect: X1) -> HttpService<T, S, B, X1, U>where
    X1: ServiceFactory<Request, Config = (), Response = Request>,
    X1::Error: Into<Response<BoxBody>>,
    X1::InitError: Debug,

Sets service for Expect: 100-Continue handling.

An expect service is called with requests that contain an Expect header. A successful response type is also a request which will be forwarded to the main service.

pub fn upgrade<U1>(self, upgrade: Option<U1>) -> HttpService<T, S, B, X, U1>where
    U1: ServiceFactory<(Request, Framed<T, Codec>), Config = (), Response = ()>,
    U1::Error: Display,
    U1::InitError: Debug,

Sets service for custom Connection: Upgrade handling.

If service is provided then normal requests handling get halted and this service get called with original request and framed object.

impl<S, B, X, U> HttpService<TcpStream, S, B, X, U>where
    S: ServiceFactory<Request, Config = ()>,
    S::Future: 'static,
    S::Error: Into<Response<BoxBody>> + 'static,
    S::InitError: Debug,
    S::Response: Into<Response<B>> + 'static,
    <S::Service as Service<Request>>::Future: 'static,
    B: MessageBody + 'static,
    X: ServiceFactory<Request, Config = (), Response = Request>,
    X::Future: 'static,
    X::Error: Into<Response<BoxBody>>,
    X::InitError: Debug,
    U: ServiceFactory<(Request, Framed<TcpStream, Codec>), Config = (), Response = ()>,
    U::Future: 'static,
    U::Error: Display + Into<Response<BoxBody>>,
    U::InitError: Debug,

pub fn tcp(
    self
) -> impl ServiceFactory<TcpStream, Config = (), Response = (), Error = DispatchError, InitError = ()>

Creates TCP stream service from HTTP service.

The resulting service only supports HTTP/1.x.

pub fn tcp_auto_h2c(
    self
) -> impl ServiceFactory<TcpStream, Config = (), Response = (), Error = DispatchError, InitError = ()>

Creates TCP stream service from HTTP service that automatically selects HTTP/1.x or HTTP/2 on plaintext connections.

Trait Implementations

impl<T, S, B, X, U> ServiceFactory<(T, Protocol, Option<SocketAddr>)> for HttpService<T, S, B, X, U>where
    T: AsyncRead + AsyncWrite + Unpin + 'static,
    S: ServiceFactory<Request, Config = ()>,
    S::Future: 'static,
    S::Error: Into<Response<BoxBody>> + 'static,
    S::InitError: Debug,
    S::Response: Into<Response<B>> + 'static,
    <S::Service as Service<Request>>::Future: 'static,
    B: MessageBody + 'static,
    X: ServiceFactory<Request, Config = (), Response = Request>,
    X::Future: 'static,
    X::Error: Into<Response<BoxBody>>,
    X::InitError: Debug,
    U: ServiceFactory<(Request, Framed<T, Codec>), Config = (), Response = ()>,
    U::Future: 'static,
    U::Error: Display + Into<Response<BoxBody>>,
    U::InitError: Debug,

type Response = ()

Responses given by the created services.

type Error = DispatchError

Errors produced by the created services.

type Config = ()

Service factory configuration.

type Service = HttpServiceHandler<T, <S as ServiceFactory<Request<Pin<Box<dyn Stream<Item = Result<Bytes, PayloadError>> + 'static, Global>>>>>::Service, B, <X as ServiceFactory<Request<Pin<Box<dyn Stream<Item = Result<Bytes, PayloadError>> + 'static, Global>>>>>::Service, <U as ServiceFactory<(Request<Pin<Box<dyn Stream<Item = Result<Bytes, PayloadError>> + 'static, Global>>>, Framed<T, Codec>)>>::Service>

The kind of Service created by this factory.

type InitError = ()

Errors potentially raised while building a service.

type Future = Pin<Box<dyn Future<Output = Result<<HttpService<T, S, B, X, U> as ServiceFactory<(T, Protocol, Option<SocketAddr>)>>::Service, <HttpService<T, S, B, X, U> as ServiceFactory<(T, Protocol, Option<SocketAddr>)>>::InitError>> + 'static, Global>>

The future of the Service instance.g

fn new_service(&self, _: ()) -> Self::Future

Create and return a new service asynchronously.