Class

tapir

Endpoint

Related Doc: package tapir

Permalink

case class Endpoint[I, E, O, +S](input: EndpointInput[I], errorOutput: EndpointOutput[E], output: EndpointOutput[O], info: EndpointInfo) extends Product with Serializable

I

Input parameter types.

E

Error output parameter types.

O

Output parameter types.

S

The type of streams that are used by this endpoint's inputs/outputs. Nothing, if no streams are used.

Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Endpoint
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Endpoint(input: EndpointInput[I], errorOutput: EndpointOutput[E], output: EndpointOutput[O], info: EndpointInfo)

    Permalink

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. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  5. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  6. def connect: Endpoint[I, E, O, S]

    Permalink
  7. def delete: Endpoint[I, E, O, S]

    Permalink
  8. def description(d: String): Endpoint[I, E, O, S]

    Permalink
  9. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  10. def errorOut[F, EF](i: EndpointOutput[F])(implicit ts: typelevel.ParamConcat.Aux[E, F, EF]): Endpoint[I, EF, O, S]

    Permalink
  11. val errorOutput: EndpointOutput[E]

    Permalink
  12. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  13. def get: Endpoint[I, E, O, S]

    Permalink
  14. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  15. def head: Endpoint[I, E, O, S]

    Permalink
  16. def in[J, IJ, S2 >: S](i: StreamingEndpointIO[J, S2])(implicit ts: typelevel.ParamConcat.Aux[I, J, IJ]): Endpoint[IJ, E, O, S2]

    Permalink
  17. def in[J, IJ](i: EndpointInput[J])(implicit ts: typelevel.ParamConcat.Aux[I, J, IJ]): Endpoint[IJ, E, O, S]

    Permalink
  18. def info(i: EndpointInfo): Endpoint[I, E, O, S]

    Permalink
  19. val info: EndpointInfo

    Permalink
  20. val input: EndpointInput[I]

    Permalink
  21. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  22. def mapErrorOut[EE](f: (E) ⇒ EE)(g: (EE) ⇒ E)(implicit paramsAsArgs: ParamsAsArgs[E]): Endpoint[I, EE, O, S]

    Permalink
  23. def mapErrorOutTo[COMPANION, CASE_CLASS <: Product](c: COMPANION)(implicit fc: FnComponents[COMPANION, E, CASE_CLASS], paramsAsArgs: ParamsAsArgs[E]): Endpoint[I, CASE_CLASS, O, S]

    Permalink
  24. def mapIn[II](f: (I) ⇒ II)(g: (II) ⇒ I)(implicit paramsAsArgs: ParamsAsArgs[I]): Endpoint[II, E, O, S]

    Permalink
  25. def mapInTo[COMPANION, CASE_CLASS <: Product](c: COMPANION)(implicit fc: FnComponents[COMPANION, I, CASE_CLASS], paramsAsArgs: ParamsAsArgs[I]): Endpoint[CASE_CLASS, E, O, S]

    Permalink
  26. def mapOut[OO](f: (O) ⇒ OO)(g: (OO) ⇒ O)(implicit paramsAsArgs: ParamsAsArgs[O]): Endpoint[I, E, OO, S]

    Permalink
  27. def mapOutTo[COMPANION, CASE_CLASS <: Product](c: COMPANION)(implicit fc: FnComponents[COMPANION, O, CASE_CLASS], paramsAsArgs: ParamsAsArgs[O]): Endpoint[I, E, CASE_CLASS, S]

    Permalink
  28. def method(m: String): Endpoint[I, E, O, S]

    Permalink
  29. def name(n: String): Endpoint[I, E, O, S]

    Permalink
  30. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  31. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  32. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  33. def options: Endpoint[I, E, O, S]

    Permalink
  34. def out[P, OP, S2 >: S](i: StreamingEndpointIO[P, S2])(implicit ts: typelevel.ParamConcat.Aux[O, P, OP]): Endpoint[I, E, OP, S2]

    Permalink
  35. def out[P, OP](i: EndpointOutput[P])(implicit ts: typelevel.ParamConcat.Aux[O, P, OP]): Endpoint[I, E, OP, S]

    Permalink
  36. val output: EndpointOutput[O]

    Permalink
  37. def patch: Endpoint[I, E, O, S]

    Permalink
  38. def post: Endpoint[I, E, O, S]

    Permalink
  39. def put: Endpoint[I, E, O, S]

    Permalink
  40. def renderPathTemplate(renderPathParam: RenderPathParam = RenderPathTemplate.Defaults.path, renderQueryParam: Option[RenderQueryParam] = ..., includeAuth: Boolean = true): String

    Permalink

    Renders endpoint path, by default all parametrised path and query components are replaced by {param_name} or {paramN}, e.g.

    Renders endpoint path, by default all parametrised path and query components are replaced by {param_name} or {paramN}, e.g. for

    endpoint.in("p1" / path[String] / query[String]("par2"))

    returns /p1/{param1}?par2={par2}

    includeAuth

    Should authentication inputs be included in the result.

  41. def serverLogic[F[_]](f: (I) ⇒ F[Either[E, O]]): ServerEndpoint[I, E, O, S, F]

    Permalink
  42. def show: String

    Permalink

    Basic information about the endpoint, excluding mapping information, with inputs sorted (first the method, then path, etc.)

  43. def showDetail: String

    Permalink

    Detailed description of the endpoint, with inputs/outputs represented in the same order as originally defined, including mapping information.

  44. def showRaw: String

    Permalink

    Equivalent to .toString, shows the whole case class structure.

  45. def summary(s: String): Endpoint[I, E, O, S]

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

    Permalink
    Definition Classes
    AnyRef
  47. def tag(t: String): Endpoint[I, E, O, S]

    Permalink
  48. def tags(ts: List[String]): Endpoint[I, E, O, S]

    Permalink
  49. def trace: Endpoint[I, E, O, S]

    Permalink
  50. final def wait(): Unit

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

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

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

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped