Trait

endpoints.play.server.circe

JsonEntities

Related Doc: package circe

Permalink

trait JsonEntities extends Endpoints with algebra.JsonEntities

Interpreter for algebra.JsonEntities that uses circe’s io.circe.Decoder to decode JSON entities in HTTP requests, and circe’s io.circe.Encoder to build JSON entities in HTTP responses.

Source
JsonEntities.scala
Linear Supertypes
algebra.JsonEntities, Endpoints, Methods, Urls, algebra.Endpoints, Responses, Requests, algebra.Methods, algebra.Urls, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. JsonEntities
  2. JsonEntities
  3. Endpoints
  4. Methods
  5. Urls
  6. Endpoints
  7. Responses
  8. Requests
  9. Methods
  10. Urls
  11. AnyRef
  12. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

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

    Permalink
    Definition Classes
    Urls

  2. case class Endpoint[A, B] extends Product with Serializable

    Permalink
    Definition Classes
    Endpoints

  3. case class EndpointWithHandler[A, B] extends ToPlayHandler with Product with Serializable

    Permalink
    Definition Classes
    Endpoints

  4. type JsonRequest[A] = Decoder[A]

    Permalink

    Decode requests using circe’s io.circe.Decoder

    Decode requests using circe’s io.circe.Decoder

    Definition Classes
    JsonEntities → JsonEntities

  5. type JsonResponse[A] = Encoder[A]

    Permalink

    Encode responses using circe’s io.circe.Encoder

    Encode responses using circe’s io.circe.Encoder

    Definition Classes
    JsonEntities → JsonEntities

  6. case class Method extends Product with Serializable

    Permalink
    Definition Classes
    Methods

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

    Permalink
    Definition Classes
    Endpoints

  8. trait Path[A] extends Url[A]

    Permalink
    Definition Classes
    Urls

  9. implicit class PathOps[A] extends AnyRef

    Permalink
    Definition Classes
    Urls

  10. trait QueryString[A] extends AnyRef

    Permalink
    Definition Classes
    Urls

  11. implicit class QueryStringOps[A] extends AnyRef

    Permalink
    Definition Classes
    Urls

  12. trait QueryStringParam[A] extends AnyRef

    Permalink
    Definition Classes
    Urls

  13. trait Request[A] extends AnyRef

    Permalink
    Definition Classes
    Endpoints

  14. type RequestEntity[A] = BodyParser[A]

    Permalink
    Definition Classes
    Endpoints → Requests

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

    Permalink
    Definition Classes
    Urls

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

    Permalink
    Definition Classes
    Endpoints → Requests

  17. type Response[A] = (A) ⇒ Result

    Permalink
    Definition Classes
    Endpoints → Responses

  18. trait Segment[A] extends AnyRef

    Permalink
    Definition Classes
    Urls

  19. trait ToPlayHandler extends AnyRef

    Permalink
    Definition Classes
    Endpoints

  20. trait Url[A] extends AnyRef

    Permalink
    Definition Classes
    Urls

  21. trait UrlAndHeaders[A] extends AnyRef

    Permalink
    Definition Classes
    Endpoints

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  4. def Delete: Method

    Permalink
    Definition Classes
    Methods → Methods

  5. def Get: Method

    Permalink
    Definition Classes
    Methods → Methods

  6. def Post: Method

    Permalink
    Definition Classes
    Methods → Methods

  7. def Put: Method

    Permalink
    Definition Classes
    Methods → Methods

  8. implicit lazy val applicativeRequestExtractor: Applicative[RequestExtractor]

    Permalink
    Definition Classes
    Urls

  9. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

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

    Permalink
    Definition Classes
    Urls → Urls

  11. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Permalink
    Definition Classes
    Urls → Urls

  13. lazy val emptyHeaders: RequestHeaders[Unit]

    Permalink
    Definition Classes
    Endpoints → Requests

  14. lazy val emptyRequest: BodyParser[Unit]

    Permalink
    Definition Classes
    Endpoints → Requests

  15. lazy val emptyResponse: Response[Unit]

    Permalink
    Definition Classes
    Endpoints → Responses

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

    Permalink
    Definition Classes
    Endpoints → Endpoints

  17. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  18. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  19. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  20. implicit lazy val functorRequestExtractor: Functor[RequestExtractor]

    Permalink
    Definition Classes
    Urls

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

    Permalink
    Definition Classes
    Requests

  22. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any

  23. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  24. lazy val htmlResponse: Response[Html]

    Permalink
    Definition Classes
    Endpoints

  25. implicit def intQueryString: QueryStringParam[Int]

    Permalink
    Definition Classes
    Urls → Urls

  26. implicit def intSegment: Segment[Int]

    Permalink
    Definition Classes
    Urls → Urls

  27. implicit lazy val invariantFunctorRequest: InvariantFunctor[Request]

    Permalink
    Definition Classes
    Endpoints

  28. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  29. def jsonRequest[A](implicit arg0: Decoder[A]): RequestEntity[A]

    Permalink
    Definition Classes
    JsonEntities → JsonEntities

  30. def jsonResponse[A](implicit arg0: Encoder[A]): Response[A]

    Permalink
    Definition Classes
    JsonEntities → JsonEntities

  31. implicit def longQueryString: QueryStringParam[Long]

    Permalink
    Definition Classes
    Urls → Urls

  32. implicit def longSegment: Segment[Long]

    Permalink
    Definition Classes
    Urls → Urls

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

    Permalink
    Definition Classes
    Endpoints → Endpoints

  34. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  35. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  36. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

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

    Permalink
    Definition Classes
    Urls → Urls

  38. val path: Path[Unit]

    Permalink
    Definition Classes
    Urls

  39. 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]

    Permalink
    Definition Classes
    Requests

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

    Permalink
    Definition Classes
    Urls → Urls

  41. 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]

    Permalink
    Definition Classes
    Endpoints → Requests

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

    Permalink
    Definition Classes
    Endpoints

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

    Permalink
    Definition Classes
    Urls → Urls

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

    Permalink
    Definition Classes
    Urls → Urls

  45. implicit def stringQueryString: QueryStringParam[String]

    Permalink
    Definition Classes
    Urls → Urls

  46. implicit def stringSegment: Segment[String]

    Permalink
    Definition Classes
    Urls → Urls

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

    Permalink
    Definition Classes
    AnyRef

  48. lazy val textResponse: Response[String]

    Permalink
    Definition Classes
    Endpoints → Responses

  49. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any

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

    Permalink
    Definition Classes
    Urls → Urls

  51. val utf8Name: String

    Permalink
    Definition Classes
    Urls

  52. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  54. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from algebra.JsonEntities

Inherited from Endpoints

Inherited from Methods

Inherited from Urls

Inherited from algebra.Endpoints

Inherited from Responses

Inherited from Requests

Inherited from algebra.Methods

Inherited from algebra.Urls

Inherited from AnyRef

Inherited from Any

Ungrouped