Request

endpoints4s.play.server.EndpointsWithCustomErrors.Request
trait Request[A]

An HTTP request.

Has an instance of InvariantFunctor.

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any

Members list

Type members

Types

type EntityData
type UrlData

Value members

Abstract methods

def aggregateAndValidate(urlData: UrlData, headersData: HeadersData, entityData: EntityData): Validated[A]
def entity: () => EntityData

The entity of this request

The entity of this request

Attributes

def headers: () => HeadersData

The headers component of this request

The headers component of this request

Attributes

def matchRequest(requestHeader: RequestHeader): Option[() => A]

Returns a RequestEntity[A] (that is, a way to decode the entity of the incoming request) if the incoming request matches the method and URL of this request description.

Returns a RequestEntity[A] (that is, a way to decode the entity of the incoming request) if the incoming request matches the method and URL of this request description.

Attributes

def method: Method

The method of this request

The method of this request

Attributes

def url: Url[UrlData]

The URL component of this request

The URL component of this request

Attributes

def urlData(a: A): UrlData

Concrete methods

final def encode(a: A): Call

Reverse routing.

Reverse routing.

Value parameters

a

Information carried by the request

Attributes

Returns

The URL and HTTP verb matching the a value.

final protected def matchRequestAndParseHeaders(requestHeader: RequestHeader)(entity: (UrlData, HeadersData) => () => A): Option[() => A]

Attributes

Returns

If the incoming requestHeader match this request description (the method and URL), validate the request URL parameters and headers. Otherwise, returns None.

final protected def parseRequestAndHeaders(requestHeader: RequestHeader): Option[Validated[(UrlData, HeadersData)]]

Attributes

Returns

Parsed and validated request data.