CirceEntities

Partial interpreter for JsonEntities: only fixes the carrier types, but does not implement the abstract methods.

Uses CirceCodec for both HTTP responses and requests.

It means that, from a client point of view, you will need a complete code even if you only want to build a request entity (despite that a io.circe.Encoder would have sufficed).

The idea is to share codecs between client-side and server-side code, thus guaranteeing consistency between both sides.

Typical usage:

/* shared MyDto.scala */  *
case class MyDto(i: Int, s: String)

object MyDto {
  import io.circe.{Encoder, Decoder}
  import io.circe.generic.semiauto.{deriveEncoder, deriveDecoder}

  implicit val encoder: Encoder[MyDto] = deriveEncoder
  implicit val decoder: Decoder[MyDto] = deriveDecoder
}

/* shared endpoint definition */  *
trait MyEndpoints extends algebra.Endpoints with algebra.CirceEntities {
  val myEndpoint = endpoint(get(path), jsonResponse[MyDto])
}

/* client MyEndpointsClient.scala */  *
object MyEndpointsClient extends MyEndpoints with xhr.CirceEntities with xhr.faithful.Endpoints

MyEndpointsClient.myEndpoint().map(myDto => println(myDto.i))

/* server MyEndpointsServer.scala */  *
object MyEndpointsServer extends MyEndpoints with play.server.CirceEntities {

  val routes = routesFromEndpoints(
    myEndpoint.implementedBy(_ => MyDto(42, "foo"))
  )

}

Source: CirceEntities.scala

Linear Supertypes

JsonEntities, Endpoints, Responses, Requests, Methods, Urls, AnyRef, Any

Type Members

abstract type Endpoint[A, B]

Definition Classes
Endpoints
type JsonRequest[A] = CirceCodec[A]

Definition Classes
CirceEntities → JsonEntities
type JsonResponse[A] = CirceCodec[A]

Definition Classes
CirceEntities → JsonEntities
abstract type Method

Definition Classes
Methods
abstract type MuxEndpoint[Req <: MuxRequest, Resp, Transport]

Definition Classes
Endpoints
abstract type Path[A] <: Url[A]

Definition Classes
Urls
implicit class PathOps[A] extends AnyRef

Definition Classes
Urls
abstract type QueryString[A]

Definition Classes
Urls
implicit class QueryStringOps[A] extends AnyRef

Definition Classes
Urls
abstract type QueryStringParam[A]

Definition Classes
Urls
abstract type Request[A]

Definition Classes
Requests
abstract type RequestEntity[A]

Definition Classes
Requests
abstract type RequestHeaders[A]

Definition Classes
Requests
abstract type Response[A]

Definition Classes
Responses
abstract type Segment[A]

Definition Classes
Urls
abstract type Url[A]

Definition Classes
Urls

Abstract Value Members

abstract def Delete: Method

Definition Classes
Methods
abstract def Get: Method

Definition Classes
Methods
abstract def Post: Method

Definition Classes
Methods
abstract def Put: Method

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

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

Definition Classes
Urls
abstract def emptyHeaders: RequestHeaders[Unit]

Definition Classes
Requests
abstract def emptyRequest: RequestEntity[Unit]

Definition Classes
Requests
abstract def emptyResponse: Response[Unit]

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

Definition Classes
Endpoints
implicit abstract def intQueryString: QueryStringParam[Int]

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

Definition Classes
Urls
abstract def jsonRequest[A](implicit arg0: JsonRequest[A]): RequestEntity[A]

Definition Classes
JsonEntities
abstract def jsonResponse[A](implicit arg0: JsonResponse[A]): Response[A]

Definition Classes
JsonEntities
implicit abstract def longQueryString: QueryStringParam[Long]

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

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

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

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

Definition Classes
Urls
abstract 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]

Definition Classes
Requests
abstract def segment[A](implicit s: Segment[A]): Path[A]

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

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

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

Definition Classes
Urls
abstract def textResponse: Response[String]

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

Definition Classes
Urls

Concrete Value Members

final def !=(arg0: AnyRef): Boolean

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

Definition Classes
Any
final def ##(): Int

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

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

Definition Classes
Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
implicit def circeJsonDecoder[A](implicit circeDecoder: io.circe.Decoder[A]): Decoder[Json, A]

Provides a Json io.circe.Decoder based on an existing circe decoder
implicit def circeJsonEncoder[A](implicit circeEncoder: io.circe.Encoder[A]): Encoder[A, Json]

Provides a Json Encoder based on an existing circe encoder
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
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] )
final def get[A, B](url: Url[A], headers: RequestHeaders[B])(implicit tuplerAC: Tupler[A, B]): Request[Out]

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

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
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
Requests
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
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( ... )

trait CirceEntities extends JsonEntities

Type Members

abstract type Endpoint[A, B]

type JsonRequest[A] = CirceCodec[A]

type JsonResponse[A] = CirceCodec[A]

abstract type Method

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

abstract type Path[A] <: Url[A]

implicit class PathOps[A] extends AnyRef

abstract type QueryString[A]

implicit class QueryStringOps[A] extends AnyRef

abstract type QueryStringParam[A]

abstract type Request[A]

abstract type RequestEntity[A]

abstract type RequestHeaders[A]

abstract type Response[A]

abstract type Segment[A]

abstract type Url[A]

Abstract Value Members

abstract def Delete: Method

abstract def Get: Method

abstract def Post: Method

abstract def Put: Method

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

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

abstract def emptyHeaders: RequestHeaders[Unit]

abstract def emptyRequest: RequestEntity[Unit]

abstract def emptyResponse: Response[Unit]

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

implicit abstract def intQueryString: QueryStringParam[Int]

implicit abstract def intSegment: Segment[Int]

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

abstract def jsonResponse[A](implicit arg0: JsonResponse[A]): Response[A]

implicit abstract def longQueryString: QueryStringParam[Long]

implicit abstract def longSegment: Segment[Long]

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

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

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

abstract 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]

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

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

implicit abstract def stringQueryString: QueryStringParam[String]

implicit abstract def stringSegment: Segment[String]

abstract def textResponse: Response[String]

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

Concrete Value Members

final def !=(arg0: AnyRef): Boolean

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: AnyRef): Boolean

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

implicit def circeJsonDecoder[A](implicit circeDecoder: io.circe.Decoder[A]): Decoder[Json, A]

implicit def circeJsonEncoder[A](implicit circeEncoder: io.circe.Encoder[A]): Encoder[A, Json]

def clone(): AnyRef

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

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

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

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]

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

def toString(): String

final def wait(): Unit

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

final def wait(arg0: Long): Unit

Inherited from JsonEntities

Inherited from Endpoints

Inherited from Responses

Inherited from Requests

Inherited from Methods

Inherited from Urls

Inherited from AnyRef