Struct actix_web::dev::ServiceRequest

pub struct ServiceRequest { /* private fields */ }

A service level request wrapper.

Allows mutable access to request’s internal structures.

Implementations

impl ServiceRequest

pub fn into_parts(self) -> (HttpRequest, Payload)

Deconstruct ServiceRequest into inner parts.

pub fn parts_mut(&mut self) -> (&mut HttpRequest, &mut Payload)

Returns mutable accessors to inner parts.

pub fn parts(&self) -> (&HttpRequest, &Payload)

Returns immutable accessors to inner parts.

pub fn request(&self) -> &HttpRequest

Returns immutable accessor to inner HttpRequest.

pub fn extract<T>(&mut self) -> <T as FromRequest>::Future

where T: FromRequest,

Derives a type from this request using an extractor.

Returns the T extractor’s Future type which can be awaited. This is particularly handy when you want to use an extractor in a middleware implementation.

Examples

use actix_web::{
    dev::{ServiceRequest, ServiceResponse},
    web::Path, Error
};

async fn my_helper(mut srv_req: ServiceRequest) -> Result<ServiceResponse, Error> {
    let path = srv_req.extract::<Path<(String, u32)>>().await?;
    // [...]
}

pub fn from_parts(req: HttpRequest, payload: Payload) -> Self

Construct request from parts.

pub fn from_request(req: HttpRequest) -> Self

Construct ServiceRequest with no payload from given HttpRequest.

pub fn into_response<B, R: Into<Response<B>>>( self, res: R, ) -> ServiceResponse<B>

Create ServiceResponse from this request and given response.

pub fn error_response<E: Into<Error>>(self, err: E) -> ServiceResponse

Create ServiceResponse from this request and given error.

pub fn head(&self) -> &RequestHead

Returns a reference to the request head.

pub fn head_mut(&mut self) -> &mut RequestHead

Returns a mutable reference to the request head.

pub fn uri(&self) -> &Uri

Returns the request URI.

pub fn method(&self) -> &Method

Returns the request method.

pub fn version(&self) -> Version

Returns the request version.

pub fn headers(&self) -> &HeaderMap

Returns a reference to request headers.

pub fn headers_mut(&mut self) -> &mut HeaderMap

Returns a mutable reference to request headers.

pub fn path(&self) -> &str

Returns request path.

pub fn query_string(&self) -> &str

Counterpart to HttpRequest::query_string.

pub fn peer_addr(&self) -> Option<SocketAddr>

Returns peer’s socket address.

See HttpRequest::peer_addr for more details.

pub fn connection_info(&self) -> Ref<'_, ConnectionInfo>

Returns a reference to connection info.

pub fn match_info(&self) -> &Path<Url>

Counterpart to HttpRequest::match_info.

pub fn match_info_mut(&mut self) -> &mut Path<Url>

Returns a mutable reference to the path match information.

pub fn match_name(&self) -> Option<&str>

Counterpart to HttpRequest::match_name.

pub fn match_pattern(&self) -> Option<String>

Counterpart to HttpRequest::match_pattern.

pub fn resource_map(&self) -> &ResourceMap

Returns a reference to the application’s resource map. Counterpart to HttpRequest::resource_map.

pub fn app_config(&self) -> &AppConfig

Counterpart to HttpRequest::app_config.

pub fn app_data<T: 'static>(&self) -> Option<&T>

Counterpart to HttpRequest::app_data.

pub fn conn_data<T: 'static>(&self) -> Option<&T>

Counterpart to HttpRequest::conn_data.

pub fn cookies(&self) -> Result<Ref<'_, Vec<Cookie<'static>>>, CookieParseError>

Available on crate feature cookies only.

Return request cookies.

pub fn cookie(&self, name: &str) -> Option<Cookie<'static>>

Available on crate feature cookies only.

Return request cookie.

pub fn set_payload(&mut self, payload: Payload)

Set request payload.

pub fn add_data_container(&mut self, extensions: Rc<Extensions>)

Add data container to request’s resolution set.

In middleware, prefer extensions_mut for request-local data since it is assumed that the same app data is presented for every request.

pub fn guard_ctx(&self) -> GuardContext<'_>

Creates a context object for use with a routing guard.

Trait Implementations

impl Debug for ServiceRequest

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

Formats the value using the given formatter.

impl HttpMessage for ServiceRequest

type Stream = Pin<Box<dyn Stream<Item = Result<Bytes, PayloadError>>>>

Type of message payload stream

fn headers(&self) -> &HeaderMap

Read the message headers.

fn extensions(&self) -> Ref<'_, Extensions>

Returns a reference to the request-local data/extensions container.

fn extensions_mut(&self) -> RefMut<'_, Extensions>

Returns a mutable reference to the request-local data/extensions container.

fn take_payload(&mut self) -> Payload<Self::Stream>

Message payload stream

fn content_type(&self) -> &str

Read the request content type. If request did not contain a Content-Type header, an empty string is returned.

fn encoding(&self) -> Result<&'static Encoding, ContentTypeError>

Get content type encoding.

fn mime_type(&self) -> Result<Option<Mime>, ContentTypeError>

Convert the request content type to a known mime type.

fn chunked(&self) -> Result<bool, ParseError>

Check if request has chunked transfer encoding.

impl Resource for ServiceRequest

type Path = Url

Type of resource’s path returned in resource_path.

fn resource_path(&mut self) -> &mut Path<Self::Path>

impl<B> Service<ServiceRequest> for Next<B>

type Response = ServiceResponse<B>

Responses given by the service.

type Error = Error

Errors produced by the service when polling readiness or executing call.

type Future = Pin<Box<dyn Future<Output = Result<<Next<B> as Service<ServiceRequest>>::Response, <Next<B> as Service<ServiceRequest>>::Error>>>>

The future response value.

fn poll_ready(&self, cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>>

Returns Ready when the service is able to process requests.

fn call(&self, req: ServiceRequest) -> Self::Future

Process the request and return the response asynchronously.

impl ServiceFactory<ServiceRequest> for Route

type Response = ServiceResponse

Responses given by the created services.

type Error = Error

Errors produced by the created services.

type Config = ()

Service factory configuration.

type Service = RouteService

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<<Route as ServiceFactory<ServiceRequest>>::Service, <Route as ServiceFactory<ServiceRequest>>::InitError>>>>

The future of the Service instance.g

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

Create and return a new service asynchronously.

impl<S, B> Transform<S, ServiceRequest> for Compress

where B: MessageBody, S: Service<ServiceRequest, Response = ServiceResponse<B>, Error = Error>,

Available on crate feature __compress only.

type Response = ServiceResponse<EitherBody<Encoder<B>>>

Responses produced by the service.

type Error = Error

Errors produced by the service.

type Transform = CompressMiddleware<S>

The TransformService value created by this factory

type InitError = ()

Errors produced while building a transform service.

type Future = Ready<Result<<Compress as Transform<S, ServiceRequest>>::Transform, <Compress as Transform<S, ServiceRequest>>::InitError>>

The future response value.

fn new_transform(&self, service: S) -> Self::Future

Creates and returns a new Transform component, asynchronously

impl<S, B> Transform<S, ServiceRequest> for DefaultHeaders

where S: Service<ServiceRequest, Response = ServiceResponse<B>, Error = Error>, S::Future: 'static,

type Response = ServiceResponse<B>

Responses produced by the service.

type Error = Error

Errors produced by the service.

type Transform = DefaultHeadersMiddleware<S>

The TransformService value created by this factory

type InitError = ()

Errors produced while building a transform service.

type Future = Ready<Result<<DefaultHeaders as Transform<S, ServiceRequest>>::Transform, <DefaultHeaders as Transform<S, ServiceRequest>>::InitError>>

The future response value.

fn new_transform(&self, service: S) -> Self::Future

Creates and returns a new Transform component, asynchronously

impl<S, B> Transform<S, ServiceRequest> for ErrorHandlers<B>

where S: Service<ServiceRequest, Response = ServiceResponse<B>, Error = Error> + 'static, S::Future: 'static, B: 'static,

type Response = ServiceResponse<EitherBody<B>>

Responses produced by the service.

type Error = Error

Errors produced by the service.

type Transform = ErrorHandlersMiddleware<S, B>

The TransformService value created by this factory

type InitError = ()

Errors produced while building a transform service.

type Future = Pin<Box<dyn Future<Output = Result<<ErrorHandlers<B> as Transform<S, ServiceRequest>>::Transform, <ErrorHandlers<B> as Transform<S, ServiceRequest>>::InitError>>>>

The future response value.

fn new_transform(&self, service: S) -> Self::Future

Creates and returns a new Transform component, asynchronously

impl<S, B> Transform<S, ServiceRequest> for Logger

where S: Service<ServiceRequest, Response = ServiceResponse<B>, Error = Error>, B: MessageBody,

type Response = ServiceResponse<StreamLog<B>>

Responses produced by the service.

type Error = Error

Errors produced by the service.

type Transform = LoggerMiddleware<S>

The TransformService value created by this factory

type InitError = ()

Errors produced while building a transform service.

type Future = Ready<Result<<Logger as Transform<S, ServiceRequest>>::Transform, <Logger as Transform<S, ServiceRequest>>::InitError>>

The future response value.

fn new_transform(&self, service: S) -> Self::Future

Creates and returns a new Transform component, asynchronously

impl<S, B> Transform<S, ServiceRequest> for NormalizePath

where S: Service<ServiceRequest, Response = ServiceResponse<B>, Error = Error>, S::Future: 'static,

type Response = ServiceResponse<B>

Responses produced by the service.

type Error = Error

Errors produced by the service.

type Transform = NormalizePathNormalization<S>

The TransformService value created by this factory

type InitError = ()

Errors produced while building a transform service.

type Future = Ready<Result<<NormalizePath as Transform<S, ServiceRequest>>::Transform, <NormalizePath as Transform<S, ServiceRequest>>::InitError>>

The future response value.

fn new_transform(&self, service: S) -> Self::Future

Creates and returns a new Transform component, asynchronously