Trait

endpoints.xhr.circe

JsonEntities

Related Doc: package circe

Permalink

trait JsonEntities extends Endpoints with algebra.JsonEntities

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

Source
JsonEntities.scala
Linear Supertypes
algebra.JsonEntities, Endpoints, Methods, Urls, algebra.Endpoints, 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. Methods
  8. Urls
  9. AnyRef
  10. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. type Endpoint[A, B] = Function1[A, Result[B]]

    Permalink
    Definition Classes
    Endpoints → Endpoints

  2. type JsonRequest[A] = Encoder[A]

    Permalink

    Encode an A using circe’s io.circe.Encoder

    Encode an A using circe’s io.circe.Encoder

    Definition Classes
    JsonEntities → JsonEntities

  3. type JsonResponse[A] = Decoder[A]

    Permalink

    Decodes an A using circe’s io.circe.Decoder

    Decodes an A using circe’s io.circe.Decoder

    Definition Classes
    JsonEntities → JsonEntities

  4. type Method = String

    Permalink
    Definition Classes
    Methods → Methods

  5. abstract type MuxEndpoint[Req <: MuxRequest, Resp, Transport]

    Permalink
    Definition Classes
    Endpoints

  6. trait Path[A] extends Url[A] with Urls.PathOps[A]

    Permalink
    Definition Classes
    Urls

  7. trait PathOps[A] extends AnyRef

    Permalink
    Definition Classes
    Urls

  8. trait QueryString[A] extends Urls.QueryStringOps[A]

    Permalink
    Definition Classes
    Urls

  9. trait QueryStringOps[A] extends AnyRef

    Permalink
    Definition Classes
    Urls

  10. trait QueryStringParam[A] extends AnyRef

    Permalink
    Definition Classes
    Urls

  11. type Request[A] = Function1[A, (XMLHttpRequest, Option[Any])]

    Permalink
    Definition Classes
    Endpoints → Endpoints

  12. type RequestEntity[A] = Function2[A, XMLHttpRequest, Any]

    Permalink
    Definition Classes
    Endpoints → Endpoints

  13. type RequestHeaders[A] = Function2[A, XMLHttpRequest, Unit]

    Permalink
    Definition Classes
    Endpoints → Endpoints

  14. type Response[A] = Function1[XMLHttpRequest, Either[Exception, A]]

    Permalink
    Definition Classes
    Endpoints → Endpoints

  15. abstract type Result[A]

    Permalink
    Definition Classes
    Endpoints

  16. trait Segment[A] extends AnyRef

    Permalink
    Definition Classes
    Urls

  17. trait Url[A] extends AnyRef

    Permalink
    Definition Classes
    Urls

Abstract Value Members

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

    Permalink
    Definition Classes
    Endpoints

  2. abstract def muxEndpoint[Req <: MuxRequest, Resp, Transport](request: Request[Transport], response: Response[Transport]): MuxEndpoint[Req, Resp, Transport]

    Permalink
    Definition Classes
    Endpoints

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: String

    Permalink
    Definition Classes
    Methods → Methods

  5. def Get: String

    Permalink
    Definition Classes
    Methods → Methods

  6. def Post: String

    Permalink
    Definition Classes
    Methods → Methods

  7. def Put: String

    Permalink
    Definition Classes
    Methods → Methods

  8. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

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

    Permalink
    Definition Classes
    Urls → Urls

  10. def clone(): AnyRef

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

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

    Permalink
    Definition Classes
    Urls → Urls

  12. lazy val emptyHeaders: RequestHeaders[Unit]

    Permalink
    Definition Classes
    Endpoints → Endpoints

  13. lazy val emptyRequest: RequestEntity[Unit]

    Permalink
    Definition Classes
    Endpoints → Endpoints

  14. lazy val emptyResponse: Response[Unit]

    Permalink
    Definition Classes
    Endpoints → Endpoints

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

    Permalink
    Definition Classes
    AnyRef

  16. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  17. def finalize(): Unit

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

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

    Permalink
    Definition Classes
    Endpoints

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

    Permalink
    Definition Classes
    AnyRef → Any

  20. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  21. implicit lazy val intQueryString: QueryStringParam[Int]

    Permalink
    Definition Classes
    Urls → Urls

  22. implicit lazy val intSegment: Segment[Int]

    Permalink
    Definition Classes
    Urls → Urls

  23. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  24. def jsonRequest[A](implicit arg0: JsonRequest[A]): RequestEntity[A]

    Permalink
    Definition Classes
    JsonEntities → JsonEntities

  25. def jsonResponse[A](implicit decoder: Decoder[A]): Response[A]

    Permalink
    Definition Classes
    JsonEntities → JsonEntities

  26. implicit lazy val longQueryString: QueryStringParam[Long]

    Permalink
    Definition Classes
    Urls → Urls

  27. implicit lazy val longSegment: Segment[Long]

    Permalink
    Definition Classes
    Urls → Urls

  28. final def muxPerformXhr[Req <: MuxRequest, Resp, Transport](request: Request[Transport], response: Response[Transport], req: Req)(onload: (Either[Throwable, Endpoints.muxPerformXhr.Req.Response]) ⇒ Unit, onError: (XMLHttpRequest) ⇒ Unit)(implicit encoder: Encoder[Req, Transport], decoder: Decoder[Transport, Resp]): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Endpoints

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

    Permalink
    Definition Classes
    AnyRef

  30. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  31. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

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

    Permalink
    Definition Classes
    Urls → Urls

  33. val path: Path[Unit]

    Permalink
    Definition Classes
    Urls

  34. final def performXhr[A, B](request: Request[A], response: Response[B], a: A)(onload: (Either[Exception, B]) ⇒ Unit, onerror: (XMLHttpRequest) ⇒ Unit): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Endpoints

  35. 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
    Endpoints

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

    Permalink
    Definition Classes
    Urls → Urls

  37. 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 → Endpoints

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

    Permalink
    Definition Classes
    Urls → Urls

  39. def staticPathSegment(segment: String): Path[Unit] with Serializable

    Permalink
    Definition Classes
    Urls → Urls

  40. implicit lazy val stringQueryString: QueryStringParam[String]

    Permalink
    Definition Classes
    Urls → Urls

  41. implicit lazy val stringSegment: Segment[String]

    Permalink
    Definition Classes
    Urls → Urls

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

    Permalink
    Definition Classes
    AnyRef

  43. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any

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

    Permalink
    Definition Classes
    Urls → Urls

  45. final def wait(): Unit

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

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

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

  47. 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 algebra.Methods

Inherited from algebra.Urls

Inherited from AnyRef

Inherited from Any

Ungrouped