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 request into parts

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

Get mutable access to inner HttpRequest and Payload

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

Construct request from parts.

pub fn from_request(req: HttpRequest) -> Self

Construct request from request.

The returned ServiceRequest would have no payload.

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

Create service response

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

Create service response for error

pub fn head(&self) -> &RequestHead

This method returns reference to the request head

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

This method returns reference to the request head

pub fn uri(&self) -> &Uri

Request’s uri.

pub fn method(&self) -> &Method

Read the Request method.

pub fn version(&self) -> Version

Read the Request Version.

pub fn headers(&self) -> &HeaderMap

Returns request’s headers.

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

Returns mutable request’s headers.

pub fn path(&self) -> &str

The target path of this Request.

pub fn query_string(&self) -> &str

Counterpart to HttpRequest::query_string.

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

Peer socket address.

Peer address is the directly connected peer’s socket address. If a proxy is used in front of the Actix Web server, then it would be address of this proxy.

To get client connection information ConnectionInfo should be used.

Will only return None when called in unit tests.

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

Get ConnectionInfo for the current request.

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

Returns a reference to the Path parameters.

Params is a container for URL parameters. A variable segment is specified in the form {identifier}, where the identifier can be used later in a request handler to access the matched value for that segment.

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

Returns a mutable reference to the Path parameters.

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

Get a reference to a ResourceMap of current application.

pub fn app_config(&self) -> &AppConfig

Service configuration

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>

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

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

Useful if you are implementing

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 = BoxedPayloadStream

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 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 = LocalBoxFuture<'static, Result<Self::Service, Self::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 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<Self::Transform, Self::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 = LocalBoxFuture<'static, Result<Self::Transform, Self::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<Self::Transform, Self::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<Self::Transform, Self::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 Compress where
    B: MessageBody,
    S: Service<ServiceRequest, Response = ServiceResponse<B>, Error = Error>, 

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<Self::Transform, Self::InitError>>

The future response value.

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

Creates and returns a new Transform component, asynchronously