LowLevelEndpoints

Type Members

implicit final class ApplicativeMapSyntax[F[_], A] extends AnyRef

Definition Classes
Urls
case class Endpoint[A, B](request: Request[A], response: Response[B]) extends Product with Serializable

Concrete representation of an Endpoint for routing purpose.
Concrete representation of an Endpoint for routing purpose.

Definition Classes
Endpoints
case class EndpointWithHandler[A, B](endpoint: Endpoint[A, B], service: (A) ⇒ Future[B]) extends ToPlayHandler with Product with Serializable

An endpoint from which we can get a Play request handler.
An endpoint from which we can get a Play request handler.

Definition Classes
Endpoints
case class Method(value: String) extends Product with Serializable

Definition Classes
Methods
class MuxEndpoint[Req <: MuxRequest, Resp, Transport] extends AnyRef

Definition Classes
Endpoints
trait Path[A] extends PathOps[A] with Url[A]

Definition Classes
Urls
trait PathOps[A] extends AnyRef

Definition Classes
Urls
trait QueryString[A] extends QueryStringOps[A]

Query string encoding and decoding
Query string encoding and decoding

Definition Classes
Urls
trait QueryStringOps[A] extends AnyRef

Definition Classes
Urls
trait QueryStringParam[A] extends AnyRef

Definition Classes
Urls
type RawRequestEntity = play.api.mvc.Request[AnyContent]

Represents a request entity as a Play Request[AnyContent]
Represents a request entity as a Play Request[AnyContent]

Definition Classes
LowLevelEndpoints → LowLevelEndpoints
type RawResponseEntity = Result

An HTTP response is a Play Result
An HTTP response is a Play Result

Definition Classes
LowLevelEndpoints → LowLevelEndpoints
trait Request[A] extends AnyRef

An HTTP request.
An HTTP request.
Has an instance of InvariantFunctor.

Definition Classes
Endpoints
type RequestEntity[A] = BodyParser[A]

Decodes a request entity
Decodes a request entity

Definition Classes
Endpoints → Endpoints
type RequestExtractor[A] = (RequestHeader) ⇒ Option[A]

Convenient type alias modeling the extraction of an A information from request headers.
Convenient type alias modeling the extraction of an A information from request headers.
This type has an instance of Applicative.

Definition Classes
Urls
type RequestHeaders[A] = (Headers) ⇒ Either[Result, A]

An attempt to extract an A from a request headers.
An attempt to extract an A from a request headers.
Models failure by returning a Left(result). That makes it possible to early return an HTTP response if a header is wrong (e.g. if an authentication information is missing)

Definition Classes
Endpoints → Endpoints
type Response[A] = (A) ⇒ Result

Turns the A information into a proper Play Result
Turns the A information into a proper Play Result

Definition Classes
Endpoints → Endpoints
trait Segment[A] extends AnyRef

Defines how to decode and encode path segments
Defines how to decode and encode path segments

Definition Classes
Urls
trait ToPlayHandler extends AnyRef

Something that can be used as a Play request handler
Something that can be used as a Play request handler

Definition Classes
Endpoints
trait Url[A] extends AnyRef

Definition Classes
Urls
trait UrlAndHeaders[A] extends AnyRef

The URL and HTTP headers of a request.
The URL and HTTP headers of a request.

Definition Classes
Endpoints

Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def Delete: Method

Definition Classes
Methods → Methods
def Get: Method

Definition Classes
Methods → Methods
def Post: Method

Definition Classes
Methods → Methods
def Put: Method

Definition Classes
Methods → Methods
implicit lazy val applicativeRequestExtractor: Applicative[RequestExtractor]

Definition Classes
Urls
final def asInstanceOf[T0]: T0

Definition Classes
Any
def chainPaths[A, B](first: Path[A], second: Path[B])(implicit tupler: Tupler[A, B]): Path[Out]

Definition Classes
Urls → Urls
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
def combineQueryStrings[A, B](first: QueryString[A], second: QueryString[B])(implicit tupler: Tupler[A, B]): QueryString[Out]

Definition Classes
Urls → Urls
lazy val emptyHeaders: RequestHeaders[Unit]

Always succeeds in extracting no information from the headers
Always succeeds in extracting no information from the headers

Definition Classes
Endpoints → Endpoints
lazy val emptyRequest: BodyParser[Unit]

Definition Classes
Endpoints → Endpoints
lazy val emptyResponse: Response[Unit]

A successful HTTP response (status code 200) with no entity
A successful HTTP response (status code 200) with no entity

Definition Classes
Endpoints → Endpoints
def endpoint[A, B](request: Request[A], response: Response[B]): Endpoint[A, B]

Definition Classes
Endpoints → Endpoints
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
implicit lazy val functorRequestExtractor: Functor[RequestExtractor]

Definition Classes
Urls
final def get[A, B](url: Url[A], headers: RequestHeaders[B])(implicit tuplerAC: Tupler[A, B]): Request[Out]

Definition Classes
Endpoints
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
lazy val htmlResponse: Response[Html]

A successful HTTP response (status code 200) with an HTML entity
A successful HTTP response (status code 200) with an HTML entity

Definition Classes
Endpoints
implicit def intQueryString: QueryStringParam[Int]

Definition Classes
Urls → Urls
implicit def intSegment: Segment[Int]

Definition Classes
Urls → Urls
implicit lazy val invariantFunctorRequest: InvariantFunctor[Request]

Definition Classes
Endpoints
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
implicit def longQueryString: QueryStringParam[Long]

Definition Classes
Urls → Urls
implicit def longSegment: Segment[Long]

Definition Classes
Urls → Urls
def muxEndpoint[Req <: MuxRequest, Resp, Transport](request: Request[Transport], response: (Transport) ⇒ Result): MuxEndpoint[Req, Resp, Transport]

Definition Classes
Endpoints → Endpoints
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def optQs[A](name: String)(implicit value: QueryStringParam[A]): QueryString[Option[A]]

Definition Classes
Urls → Urls
val path: Path[Unit]

Definition Classes
Urls
final def post[A, B, C, AB](url: Url[A], entity: RequestEntity[B], headers: RequestHeaders[C])(implicit tuplerAB: Tupler.Aux[A, B, AB], tuplerABC: Tupler[AB, C]): Request[Out]

Definition Classes
Endpoints
def qs[A](name: String)(implicit value: QueryStringParam[A]): QueryString[A]

Definition Classes
Urls → Urls
lazy val rawRequestEntity: RequestEntity[RawRequestEntity]

Definition Classes
LowLevelEndpoints → LowLevelEndpoints
lazy val rawResponseEntity: Response[RawResponseEntity]

Definition Classes
LowLevelEndpoints → LowLevelEndpoints
def request[A, B, C, AB](method: Method, url: Url[A], entity: RequestEntity[B], headers: RequestHeaders[C])(implicit tuplerAB: Tupler.Aux[A, B, AB], tuplerABC: Tupler[AB, C]): Request[Out]

Decodes a request that uses the POST HTTP verb.
Decodes a request that uses the POST HTTP verb.
url
Request URL
entity
Request entity
headers
Request headers

Definition Classes
Endpoints → Endpoints
def routesFromEndpoints(endpoints: ToPlayHandler*): PartialFunction[RequestHeader, Handler]

Builds a Play router out of endpoint definitions.
Builds a Play router out of endpoint definitions.
```
val routes = routesFromEndpoints(
  inc.implementedBy(x => x + 1)
)
```
Definition Classes
Endpoints
def segment[A](implicit A: Segment[A]): Path[A]

Definition Classes
Urls → Urls
def staticPathSegment(segment: String): Path[Unit]

Definition Classes
Urls → Urls
implicit def stringQueryString: QueryStringParam[String]

Definition Classes
Urls → Urls
implicit def stringSegment: Segment[String]

Definition Classes
Urls → Urls
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
def urlWithQueryString[A, B](path: Path[A], qs: QueryString[B])(implicit tupler: Tupler[A, B]): Url[Out]

Definition Classes
Urls → Urls
val utf8Name: String

Definition Classes
Urls
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )

Related Doc: package routing

trait LowLevelEndpoints extends algebra.LowLevelEndpoints with Endpoints

Type Members

implicit final class ApplicativeMapSyntax[F[_], A] extends AnyRef

case class Endpoint[A, B](request: Request[A], response: Response[B]) extends Product with Serializable

case class EndpointWithHandler[A, B](endpoint: Endpoint[A, B], service: (A) ⇒ Future[B]) extends ToPlayHandler with Product with Serializable

case class Method(value: String) extends Product with Serializable

class MuxEndpoint[Req <: MuxRequest, Resp, Transport] extends AnyRef

trait Path[A] extends PathOps[A] with Url[A]

trait PathOps[A] extends AnyRef

trait QueryString[A] extends QueryStringOps[A]

trait QueryStringOps[A] extends AnyRef

trait QueryStringParam[A] extends AnyRef

type RawRequestEntity = play.api.mvc.Request[AnyContent]

type RawResponseEntity = Result

trait Request[A] extends AnyRef

type RequestEntity[A] = BodyParser[A]

type RequestExtractor[A] = (RequestHeader) ⇒ Option[A]

type RequestHeaders[A] = (Headers) ⇒ Either[Result, A]

type Response[A] = (A) ⇒ Result

trait Segment[A] extends AnyRef

trait ToPlayHandler extends AnyRef

trait Url[A] extends AnyRef

trait UrlAndHeaders[A] extends AnyRef

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

def Delete: Method

def Get: Method

def Post: Method

def Put: Method

implicit lazy val applicativeRequestExtractor: Applicative[RequestExtractor]

final def asInstanceOf[T0]: T0

def chainPaths[A, B](first: Path[A], second: Path[B])(implicit tupler: Tupler[A, B]): Path[Out]

def clone(): AnyRef

def combineQueryStrings[A, B](first: QueryString[A], second: QueryString[B])(implicit tupler: Tupler[A, B]): QueryString[Out]

lazy val emptyHeaders: RequestHeaders[Unit]

lazy val emptyRequest: BodyParser[Unit]

lazy val emptyResponse: Response[Unit]

def endpoint[A, B](request: Request[A], response: Response[B]): Endpoint[A, B]

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

implicit lazy val functorRequestExtractor: Functor[RequestExtractor]

final def get[A, B](url: Url[A], headers: RequestHeaders[B])(implicit tuplerAC: Tupler[A, B]): Request[Out]

final def getClass(): Class[_]

def hashCode(): Int

lazy val htmlResponse: Response[Html]

implicit def intQueryString: QueryStringParam[Int]

implicit def intSegment: Segment[Int]

implicit lazy val invariantFunctorRequest: InvariantFunctor[Request]

final def isInstanceOf[T0]: Boolean

implicit def longQueryString: QueryStringParam[Long]

implicit def longSegment: Segment[Long]

def muxEndpoint[Req <: MuxRequest, Resp, Transport](request: Request[Transport], response: (Transport) ⇒ Result): MuxEndpoint[Req, Resp, Transport]

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def optQs[A](name: String)(implicit value: QueryStringParam[A]): QueryString[Option[A]]

val path: Path[Unit]

final def post[A, B, C, AB](url: Url[A], entity: RequestEntity[B], headers: RequestHeaders[C])(implicit tuplerAB: Tupler.Aux[A, B, AB], tuplerABC: Tupler[AB, C]): Request[Out]

def qs[A](name: String)(implicit value: QueryStringParam[A]): QueryString[A]

lazy val rawRequestEntity: RequestEntity[RawRequestEntity]

lazy val rawResponseEntity: Response[RawResponseEntity]

def request[A, B, C, AB](method: Method, url: Url[A], entity: RequestEntity[B], headers: RequestHeaders[C])(implicit tuplerAB: Tupler.Aux[A, B, AB], tuplerABC: Tupler[AB, C]): Request[Out]

def routesFromEndpoints(endpoints: ToPlayHandler*): PartialFunction[RequestHeader, Handler]

def segment[A](implicit A: Segment[A]): Path[A]

def staticPathSegment(segment: String): Path[Unit]

implicit def stringQueryString: QueryStringParam[String]

implicit def stringSegment: Segment[String]

final def synchronized[T0](arg0: ⇒ T0): T0

def toString(): String

def urlWithQueryString[A, B](path: Path[A], qs: QueryString[B])(implicit tupler: Tupler[A, B]): Url[Out]

val utf8Name: String

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

Inherited from Endpoints