Struct actix_web::dev::ServiceRequest

pub struct ServiceRequest(_);

An service http request

ServiceRequest allows mutable access to request's internal structures

Implementations

impl ServiceRequest

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

Deconstruct request into parts

pub fn from_parts(
    req: HttpRequest,
    pl: Payload
) -> Result<Self, (HttpRequest, Payload)>

Construct request from parts.

ServiceRequest can be re-constructed only if req hasn't been cloned.

pub fn from_request(req: HttpRequest) -> Result<Self, HttpRequest>

Construct request from request.

HttpRequest implements Clone trait via Rc type. ServiceRequest can be re-constructed only if rc's strong pointers count eq 1 and weak pointers count is 0.

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

Create service response

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

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

The query string in the URL.

E.g., id=10

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

Peer socket address

Peer address is actual socket address, if proxy is used in front of actix http server, then peer address would be address of this proxy.

To get client connection information ConnectionInfo should be used.

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

Get ConnectionInfo for the current request.

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

Get 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_name(&self) -> Option<&str>

Counterpart to HttpRequest::match_name.

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

Counterpart to HttpRequest::match_pattern.

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

Get a mutable reference to the Path parameters.

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 set_payload(&mut self, payload: Payload)

Set request payload.

Trait Implementations

impl Debug for ServiceRequest

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

Formats the value using the given formatter.

impl HttpMessage for ServiceRequest

type Stream = PayloadStream

Type of message payload stream

pub fn headers(&self) -> &HeaderMap

Returns Request's headers.

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

Request extensions

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

Mutable reference to a the request's extensions

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

Message payload stream

pub fn content_type(&self) -> &str

Read the request content type. If request does not contain Content-Type header, empty str get returned.

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

Get content type encoding

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

Convert the request content type to a known mime type.

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

Check if request has chunked transfer encoding

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

Load request cookies.

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

Return request cookie.

impl<T> IntoServiceFactory<T, ServiceRequest> for Resource<T> where
    T: ServiceFactory<ServiceRequest, Config = (), Response = ServiceResponse, Error = Error, InitError = ()>, 

pub fn into_factory(self) -> T

Convert Self to a ServiceFactory

impl Resource<Url> for ServiceRequest

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

impl ServiceFactory<ServiceRequest> for Route

type Config = ()

Service factory configuration.

type Response = ServiceResponse

Responses given by the created services.

type Error = Error

Errors produced by the created services.

type InitError = ()

Errors potentially raised while building a service.

type Service = RouteService

The kind of Service created by this factory.

type Future = CreateRouteService

The future of the Service instance.

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

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

Creates and returns a new Transform component, asynchronously

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

Map this transform's factory error to a different error, returning a new transform service factory.

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

type Response = ServiceResponse<B>

Responses given 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 = Ready<Result<Self::Transform, Self::InitError>>

The future response value.

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

Creates and returns a new Transform component, asynchronously

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

Map this transform's factory error to a different error, returning a new transform service factory.

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 given by the service.

type Error = Error

Errors produced by the service.

type InitError = ()

Errors produced while building a transform service.

type Transform = LoggerMiddleware<S>

The TransformService value created by this factory

type Future = Ready<Result<Self::Transform, Self::InitError>>

The future response value.

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

Creates and returns a new Transform component, asynchronously

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

Map this transform's factory error to a different error, returning a new transform service factory.

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

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

Creates and returns a new Transform component, asynchronously

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

Map this transform's factory error to a different error, returning a new transform service factory.

impl<S, B> Transform<S, ServiceRequest> for Compress where
    B: MessageBody,
    S: Service<ServiceRequest, Response = ServiceResponse<B>, Error = Error>, 

type Response = ServiceResponse<Encoder<B>>

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

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

Creates and returns a new Transform component, asynchronously

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

Map this transform's factory error to a different error, returning a new transform service factory.