package shared
- Alphabetic
- By Inheritance
- shared
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Type Members
- sealed trait ApiElement extends AnyRef
-
sealed
trait
ApiList[H <: HList] extends AnyRef
Type level api representation encoded as HList.
Type level api representation encoded as HList. This wrapper is used to encapsulate shapeless code and enforces api structure: path -> all segment -> all query -> [query, header, body, method] header -> [header, body, method] body -> [method] method -> nothing
-
sealed
trait
ApiListWithOps[H <: HList] extends ApiList[H]
Basic operations.
- sealed trait ApiOp extends AnyRef
-
trait
ApiTransformer extends AnyRef
Separates uri, input description and out type from
ApiList
.Separates uri, input description and out type from
ApiList
. Example: val api: FinalCons[Get[Foo] :: Segment["name".type, String] :: "find".type :: HNil] = := :> "find" :> Segment[String]('name) :> Get[Foo] val trans: ("name".type :: SegmentInput :: HNil, FieldType['name.type, String :: HNil], Foo) -
final
case class
CompositionCons[H <: HList]() extends ApiList[H] with Product with Serializable
Compose multiple type level api descriptions in a HList of HLists.
- sealed trait DeleteCall extends ApiOp
- final case class DeleteElement[A]() extends ApiElement with Product with Serializable
-
final
case class
FinalCons[H <: HList]() extends ApiList[H] with Product with Serializable
A final element is a method describing the request type.
- sealed trait FoldResultEvidence[Fold] extends AnyRef
- trait FoldResultEvidenceLowPrio extends AnyRef
- sealed trait GetCall extends ApiOp
- final case class GetElement[A]() extends ApiElement with Product with Serializable
-
final
case class
HeaderCons[H <: HList]() extends ApiListWithOps[H] with Product with Serializable
Last set element is a header.
- final class HeaderHelper[A] extends AnyRef
- sealed trait HeaderInput extends ApiOp
-
final
case class
HeaderParam[S <: Symbol, A](name: Lt[S]) extends ApiElement with Product with Serializable
Header which represents its key as singleton type and describes the value type.
Header which represents its key as singleton type and describes the value type.
- name
header key
-
final
case class
PathCons[H <: HList]() extends ApiListWithOps[H] with Product with Serializable
Last set element is a path.
-
final
case class
PathElement[S](wit: Lt[S]) extends ApiElement with Product with Serializable
Static path element represented as singleton type.
Static path element represented as singleton type.
- wit
singleton type of static path element
- sealed trait PostCall extends ApiOp
- final case class PostElement[A]() extends ApiElement with Product with Serializable
- sealed trait PostWithBodyCall[Bd] extends ApiOp
- final case class PostWithBodyElement[Bd, A]() extends ApiElement with Product with Serializable
- sealed trait PutCall extends ApiOp
- final case class PutElement[A]() extends ApiElement with Product with Serializable
- sealed trait PutWithBodyCall[Bd] extends ApiOp
- final case class PutWithBodyElement[Bd, A]() extends ApiElement with Product with Serializable
-
final
case class
QueryCons[H <: HList]() extends ApiListWithOps[H] with Product with Serializable
Last set element is a query parameter.
- final class QueryHelper[A] extends AnyRef
- sealed trait QueryInput extends ApiOp
-
final
case class
QueryParam[S <: Symbol, A](name: Lt[S]) extends ApiElement with Product with Serializable
Query parameter which represents its key as singleton type and describes the value type.
Query parameter which represents its key as singleton type and describes the value type.
- name
query key
-
final
case class
RawHeadersCons[H <: HList]() extends ApiListWithOps[H] with Product with Serializable
Last set element is a header.
- sealed trait RawHeadersInput extends ApiOp
-
final
case class
ReqBodyElement[A]() extends ApiElement with Product with Serializable
Request body type description.
-
final
case class
SegmentCons[H <: HList]() extends ApiListWithOps[H] with Product with Serializable
Last set element is a segment.
- final class SegmentHelper[A] extends AnyRef
- sealed trait SegmentInput extends ApiOp
-
final
case class
SegmentParam[S <: Symbol, A](name: Lt[S]) extends ApiElement with Product with Serializable
Dynamically set segment within an URI which has a unique name to reference it on input.
Dynamically set segment within an URI which has a unique name to reference it on input.
- name
unique name reference
-
sealed
trait
TypeLevelFoldFunction[In, Agg] extends AnyRef
Reimplements shapeles Case2 but on the type level (no real HList instance)
Reimplements shapeles Case2 but on the type level (no real HList instance)
- Annotations
- @implicitNotFound( ... )
-
sealed
trait
TypeLevelFoldLeft[H <: HList, Agg] extends Serializable
Reimplements shapeless LeftFolder but on the type level (no real HList instance)
Reimplements shapeless LeftFolder but on the type level (no real HList instance)
- Annotations
- @implicitNotFound( ... )
-
trait
TypeLevelFoldLeftList[H <: HList] extends AnyRef
Helper to work on a composition of HLists we want to fold over.
- trait TypeLevelFoldLeftListLowPrio extends AnyRef
- trait TypeLevelFoldLeftLowPrio extends AnyRef
-
final
case class
WithBodyCons[Bd, H <: HList]() extends ApiList[H] with Product with Serializable
Last set element is a request body.
Value Members
- final val BodyField: Aux[@@[Symbol, String("body")]]
- final val RawHeadersField: Aux[@@[Symbol, String("rawHeaders")]]
-
object
EmptyCons extends ApiListWithOps[HNil] with Product with Serializable
Initial element with empty api description.
- object FoldResultEvidence
-
object
RawHeadersParam extends ApiElement with Product with Serializable
Convenience class to add headers as
Map[String, String]
patch.Convenience class to add headers as
Map[String, String]
patch. This class cannot guarantee type safety. - object TypeLevelFoldFunction
- object TypeLevelFoldLeft extends Serializable
- object TypeLevelFoldLeftList