Trait

endpoints.play.client

JsonEntitiesFromCodec

Related Doc: package client

Permalink

trait JsonEntitiesFromCodec extends Endpoints with algebra.JsonEntitiesFromCodec

Interpreter for endpoints.algebra.JsonEntitiesFromCodec that encodes JSON requests and decodes JSON responses.

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

Type Members

  1. type Endpoint[A, B] = (A) ⇒ Future[B]

    Permalink

    A function that, given an A, eventually attempts to decode the B response.

    A function that, given an A, eventually attempts to decode the B response.

    Communication failures and protocol failures are represented by a Future.failed.

    Definition Classes
    Endpoints → Endpoints
  2. implicit class InvariantFunctorSyntax[A, F[_]] extends AnyRef

    Permalink
    Definition Classes
    InvariantFunctorSyntax
  3. abstract type JsonCodec[A]

    Permalink
    Definition Classes
    JsonEntitiesFromCodec
  4. type JsonRequest[A] = Codec[String, A]

    Permalink
    Definition Classes
    JsonEntitiesFromCodec → JsonEntities
  5. type JsonResponse[A] = Codec[String, A]

    Permalink
    Definition Classes
    JsonEntitiesFromCodec → JsonEntities
  6. type Method = (WSRequest) ⇒ WSRequest

    Permalink

    String representation of the method

    String representation of the method

    Definition Classes
    Methods → Methods
  7. trait Path[A] extends Url[A]

    Permalink
    Definition Classes
    Urls
  8. implicit class PathOps[A] extends AnyRef

    Permalink
    Definition Classes
    Urls
  9. trait QueryString[A] extends AnyRef

    Permalink
    Definition Classes
    Urls
  10. implicit class QueryStringOps[A] extends AnyRef

    Permalink
    Definition Classes
    Urls
  11. type QueryStringParam[A] = (A) ⇒ String

    Permalink
    Definition Classes
    Urls → Urls
  12. type Request[A] = (A) ⇒ Future[WSResponse]

    Permalink

    A function that takes an A information and eventually returns a WSResponse

    A function that takes an A information and eventually returns a WSResponse

    Definition Classes
    Endpoints → Requests
  13. type RequestEntity[A] = (A, WSRequest) ⇒ WSRequest

    Permalink

    A function that, given an A information and a WSRequest, eventually returns a WSResponse

    A function that, given an A information and a WSRequest, eventually returns a WSResponse

    Definition Classes
    Endpoints → Requests
  14. type RequestHeaders[A] = (A, WSRequest) ⇒ WSRequest

    Permalink

    A function that, given an A and a request model, returns an updated request containing additional headers

    A function that, given an A and a request model, returns an updated request containing additional headers

    Definition Classes
    Endpoints → Requests
  15. type Response[A] = (WSResponse) ⇒ Either[Throwable, A]

    Permalink

    Attempts to decode an A from a WSResponse.

    Attempts to decode an A from a WSResponse.

    Definition Classes
    Endpoints → Responses
  16. trait Segment[A] extends AnyRef

    Permalink
    Definition Classes
    Urls
  17. implicit class SemigroupalSyntax[A, F[_]] extends AnyRef

    Permalink
    Definition Classes
    SemigroupalSyntax
  18. trait Url[A] extends AnyRef

    Permalink
    Definition Classes
    Urls

Abstract Value Members

  1. implicit abstract def jsonCodec[A](implicit arg0: JsonCodec[A]): Codec[String, A]

    Permalink
    Definition Classes
    JsonEntitiesFromCodec

Concrete 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 Options: Method

    Permalink
    Definition Classes
    Methods → Methods
  7. def Patch: Method

    Permalink
    Definition Classes
    Methods → Methods
  8. def Post: Method

    Permalink
    Definition Classes
    Methods → Methods
  9. def Put: Method

    Permalink
    Definition Classes
    Methods → Methods
  10. final def asInstanceOf[T0]: T0

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

    Permalink
    Definition Classes
    Urls → Urls
  12. def clone(): AnyRef

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

    Permalink
    Definition Classes
    Urls → Urls
  14. implicit def dummyPathToUrl[A](p: Path[A]): Url[A]

    Permalink
    Definition Classes
    Urls
  15. lazy val emptyHeaders: RequestHeaders[Unit]

    Permalink

    Does not modify the request

    Does not modify the request

    Definition Classes
    Endpoints → Requests
  16. lazy val emptyRequest: RequestEntity[Unit]

    Permalink
    Definition Classes
    Endpoints → Requests
  17. def emptyResponse(docs: Documentation): Response[Unit]

    Permalink

    Successfully decodes no information from a response

    Successfully decodes no information from a response

    Definition Classes
    Endpoints → Responses
  18. def endpoint[A, B](request: Request[A], response: Response[B], summary: Documentation, description: Documentation, tags: List[String]): Endpoint[A, B]

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

    Permalink
    Definition Classes
    AnyRef
  20. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  21. implicit val executionContext: ExecutionContext

    Permalink
    Definition Classes
    Endpoints
  22. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  23. final def get[UrlP, HeadersP](url: Url[UrlP], headers: RequestHeaders[HeadersP])(implicit tuplerAC: Tupler[UrlP, HeadersP]): Request[Out]

    Permalink
    Definition Classes
    Requests
  24. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  25. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  26. def header(name: String, docs: Documentation): (String, WSRequest) ⇒ WSRequest

    Permalink
    Definition Classes
    Endpoints → Requests
  27. implicit lazy val intQueryString: QueryStringParam[Int]

    Permalink
    Definition Classes
    Urls → Urls
  28. implicit lazy val intSegment: Segment[Int]

    Permalink
    Definition Classes
    Urls → Urls
  29. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  30. def jsonRequest[A](docs: Documentation)(implicit codec: Codec[String, A]): RequestEntity[A]

    Permalink
    Definition Classes
    JsonEntitiesFromCodec → JsonEntities
  31. def jsonResponse[A](docs: Documentation)(implicit codec: Codec[String, A]): Response[A]

    Permalink
    Definition Classes
    JsonEntitiesFromCodec → JsonEntities
  32. implicit lazy val longQueryString: QueryStringParam[Long]

    Permalink
    Definition Classes
    Urls → Urls
  33. implicit lazy val longSegment: Segment[Long]

    Permalink
    Definition Classes
    Urls → Urls
  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 optHeader(name: String, docs: Documentation): (Option[String], WSRequest) ⇒ WSRequest

    Permalink
    Definition Classes
    Endpoints → Requests
  38. def optQs[A](name: String, docs: Documentation)(implicit value: QueryStringParam[A]): QueryString[Option[A]]

    Permalink
    Definition Classes
    Urls → Urls
  39. def option[A](response: Response[A], notFoundDocs: Documentation): Response[Option[A]]

    Permalink
    Definition Classes
    Endpoints → Responses
  40. val path: Path[Unit]

    Permalink
    Definition Classes
    Urls
  41. final def post[UrlP, BodyP, HeadersP, UrlAndBodyPTupled](url: Url[UrlP], entity: RequestEntity[BodyP], headers: RequestHeaders[HeadersP])(implicit tuplerAB: Tupler.Aux[UrlP, BodyP, UrlAndBodyPTupled], tuplerABC: Tupler[UrlAndBodyPTupled, HeadersP]): Request[Out]

    Permalink
    Definition Classes
    Requests
  42. def qs[A](name: String, docs: Documentation)(implicit value: QueryStringParam[A]): QueryString[A]

    Permalink
    Definition Classes
    Urls → Urls
  43. implicit lazy val reqEntityInvFunctor: InvariantFunctor[RequestEntity]

    Permalink
    Definition Classes
    Endpoints → Requests
  44. implicit lazy val reqHeadersInvFunctor: InvariantFunctor[RequestHeaders]

    Permalink
    Definition Classes
    Endpoints → Requests
  45. implicit lazy val reqHeadersSemigroupal: Semigroupal[RequestHeaders]

    Permalink
    Definition Classes
    Endpoints → Requests
  46. 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
  47. def segment[A](name: String, docs: Documentation)(implicit s: Segment[A]): Path[A]

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

    Permalink
    Definition Classes
    Urls → Urls
  49. implicit lazy val stringQueryString: QueryStringParam[String]

    Permalink
    Definition Classes
    Urls → Urls
  50. implicit lazy val stringSegment: Segment[String]

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

    Permalink
    Definition Classes
    AnyRef
  52. def textRequest(docs: Documentation): (String, WSRequest) ⇒ WSRequest

    Permalink
    Definition Classes
    Endpoints → Requests
  53. def textResponse(docs: Documentation): Response[String]

    Permalink

    Successfully decodes string information from a response

    Successfully decodes string information from a response

    Definition Classes
    Endpoints → Responses
  54. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  55. implicit lazy val urlInvFunctor: InvariantFunctor[Url]

    Permalink
    Definition Classes
    Urls → Urls
  56. def urlWithQueryString[A, B](path: Path[A], qs: QueryString[B])(implicit tupler: Tupler[A, B]): Url[Out]

    Permalink
    Definition Classes
    Urls → Urls
  57. val utf8Name: String

    Permalink
    Definition Classes
    Urls
  58. final def wait(): Unit

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

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

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

Inherited from 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