c

sttp.tapir

Endpoint

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.

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)

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  6. def connect: Endpoint[I, E, O, S]
  7. def delete: Endpoint[I, E, O, S]
  8. def deprecated(): Endpoint[I, E, O, S]
  9. def description(d: String): Endpoint[I, E, O, S]
  10. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  11. def errorOut[F, EF](i: EndpointOutput[F])(implicit ts: typelevel.ParamConcat.Aux[E, F, EF]): Endpoint[I, EF, O, S]
  12. val errorOutput: EndpointOutput[E]
  13. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  14. def get: Endpoint[I, E, O, S]
  15. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  16. def head: Endpoint[I, E, O, S]
  17. def in[J, IJ, S2 >: S](i: StreamingEndpointIO[J, S2])(implicit ts: typelevel.ParamConcat.Aux[I, J, IJ]): Endpoint[IJ, E, O, S2]
  18. def in[J, IJ](i: EndpointInput[J])(implicit ts: typelevel.ParamConcat.Aux[I, J, IJ]): Endpoint[IJ, E, O, S]
  19. def info(i: EndpointInfo): Endpoint[I, E, O, S]
  20. val info: EndpointInfo
  21. val input: EndpointInput[I]
  22. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  23. def mapErrorOut[EE](f: (E) ⇒ EE)(g: (EE) ⇒ E): Endpoint[I, EE, O, S]
  24. def mapErrorOutTo[COMPANION, CASE_CLASS <: Product](c: COMPANION)(implicit fc: FnComponents[COMPANION, E, CASE_CLASS]): Endpoint[I, CASE_CLASS, O, S]
  25. def mapIn[II](f: (I) ⇒ II)(g: (II) ⇒ I): Endpoint[II, E, O, S]
  26. def mapInTo[COMPANION, CASE_CLASS <: Product](c: COMPANION)(implicit fc: FnComponents[COMPANION, I, CASE_CLASS]): Endpoint[CASE_CLASS, E, O, S]
  27. def mapOut[OO](f: (O) ⇒ OO)(g: (OO) ⇒ O): Endpoint[I, E, OO, S]
  28. def mapOutTo[COMPANION, CASE_CLASS <: Product](c: COMPANION)(implicit fc: FnComponents[COMPANION, O, CASE_CLASS]): Endpoint[I, E, CASE_CLASS, S]
  29. def method(m: String): Endpoint[I, E, O, S]
  30. def name(n: String): Endpoint[I, E, O, S]
  31. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  32. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  33. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  34. def options: Endpoint[I, E, O, S]
  35. def out[P, OP, S2 >: S](i: StreamingEndpointIO[P, S2])(implicit ts: typelevel.ParamConcat.Aux[O, P, OP]): Endpoint[I, E, OP, S2]
  36. def out[P, OP](i: EndpointOutput[P])(implicit ts: typelevel.ParamConcat.Aux[O, P, OP]): Endpoint[I, E, OP, S]
  37. val output: EndpointOutput[O]
  38. def patch: Endpoint[I, E, O, S]
  39. def post: Endpoint[I, E, O, S]
  40. def prependErrorOut[F, FE](i: EndpointOutput[F])(implicit ts: typelevel.ParamConcat.Aux[F, E, FE]): Endpoint[I, FE, O, S]
  41. def prependIn[J, JI, S2 >: S](i: StreamingEndpointIO[J, S2])(implicit ts: typelevel.ParamConcat.Aux[J, I, JI]): Endpoint[JI, E, O, S2]
  42. def prependIn[J, JI](i: EndpointInput[J])(implicit ts: typelevel.ParamConcat.Aux[J, I, JI]): Endpoint[JI, E, O, S]
  43. def prependOut[P, PO](i: EndpointOutput[P])(implicit ts: typelevel.ParamConcat.Aux[P, O, PO]): Endpoint[I, E, PO, S]
  44. def put: Endpoint[I, E, O, S]
  45. def renderPathTemplate(renderPathParam: RenderPathParam = RenderPathTemplate.Defaults.path, renderQueryParam: Option[RenderQueryParam] = ..., includeAuth: Boolean = true): String

    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.

  46. def serverLogic[F[_]](f: (I) ⇒ F[Either[E, O]]): ServerEndpoint[I, E, O, S, F]
  47. def show: String

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

  48. def showDetail: String

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

  49. def showRaw: String

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

  50. def summary(s: String): Endpoint[I, E, O, S]
  51. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  52. def tag(t: String): Endpoint[I, E, O, S]
  53. def tags(ts: List[String]): Endpoint[I, E, O, S]
  54. def trace: Endpoint[I, E, O, S]
  55. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  56. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  57. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped