Struct actix_http::HttpService

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

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

source§

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,

source

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

Available on crate feature openssl only.

Create OpenSSL based service.

source

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

Available on crate feature openssl only.

Create OpenSSL based service with custom TLS acceptor configuration.

source§

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,

source

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

Available on crate feature rustls-0_20 only.

Create Rustls v0.20 based service.

source

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

Available on crate feature rustls-0_20 only.

Create Rustls v0.20 based service with custom TLS acceptor configuration.

source§

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,

source

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

Available on crate feature rustls-0_21 only.

Create Rustls v0.21 based service.

source

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

Available on crate feature rustls-0_21 only.

Create Rustls v0.21 based service with custom TLS acceptor configuration.

source§

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,

source

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

Available on crate feature rustls-0_22 only.

Create Rustls v0.22 based service.

source

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

Available on crate feature rustls-0_22 only.

Create Rustls v0.22 based service with custom TLS acceptor configuration.

source§

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,

source

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

Available on crate feature rustls-0_23 only.

Create Rustls v0.23 based service.

source

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

Available on crate feature rustls-0_23 only.

Create Rustls v0.23 based service with custom TLS acceptor configuration.

source§

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,

source

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

Constructs builder for HttpService instance.

source§

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,

source

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

Constructs new HttpService instance from service with default config.

source§

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,

source

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.

source

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.

source§

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,

source

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.

source

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

Available on crate feature http2 only.

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

Trait Implementations§

source§

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>>::Service, B, <X as ServiceFactory<Request>>::Service, <U as ServiceFactory<(Request, 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>>>>

The future of the Service instance.g
source§

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

Create and return a new service asynchronously.

Auto Trait Implementations§

§

impl<T, S, B, X, U> Freeze for HttpService<T, S, B, X, U>
where S: Freeze, X: Freeze, U: Freeze,

§

impl<T, S, B, X = ExpectHandler, U = UpgradeHandler> !RefUnwindSafe for HttpService<T, S, B, X, U>

§

impl<T, S, B, X = ExpectHandler, U = UpgradeHandler> !Send for HttpService<T, S, B, X, U>

§

impl<T, S, B, X = ExpectHandler, U = UpgradeHandler> !Sync for HttpService<T, S, B, X, U>

§

impl<T, S, B, X, U> Unpin for HttpService<T, S, B, X, U>
where S: Unpin, X: Unpin, U: Unpin, B: Unpin,

§

impl<T, S, B, X = ExpectHandler, U = UpgradeHandler> !UnwindSafe for HttpService<T, S, B, X, U>

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.

§

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

§

impl<SF, Req> IntoServiceFactory<SF, Req> for SF
where SF: ServiceFactory<Req>,

§

fn into_factory(self) -> SF

Convert Self to a ServiceFactory
source§

impl<T> Same for T

§

type Output = T

Should always be Self
§

impl<SF, Req> ServiceFactoryExt<Req> for SF
where SF: ServiceFactory<Req>,

§

fn map<F, R>(self, f: F) -> MapServiceFactory<Self, F, Req, R>
where Self: Sized, F: FnMut(Self::Response) -> R + Clone,

Map this service’s output to a different type, returning a new service of the resulting type.
§

fn map_err<F, E>(self, f: F) -> MapErrServiceFactory<Self, Req, F, E>
where Self: Sized, F: Fn(Self::Error) -> E + Clone,

Map this service’s error to a different error, returning a new service.
§

fn map_init_err<F, E>(self, f: F) -> MapInitErr<Self, F, Req, E>
where Self: Sized, F: Fn(Self::InitError) -> E + Clone,

Map this factory’s init error to a different error, returning a new service.
§

fn and_then<I, SF1>(self, factory: I) -> AndThenServiceFactory<Self, SF1, Req>
where Self: Sized, Self::Config: Clone, I: IntoServiceFactory<SF1, Self::Response>, SF1: ServiceFactory<Self::Response, Config = Self::Config, Error = Self::Error, InitError = Self::InitError>,

Call another service after call to this one has resolved successfully.
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.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

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
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more