c

sttp.tapir.server

ServerEndpoint

case class ServerEndpoint[I, E, O, -R, F[_]](endpoint: Endpoint[I, E, O, R], logic: (MonadError[F]) ⇒ (I) ⇒ F[Either[E, O]]) extends EndpointInfoOps[I, E, O, R] with EndpointMetaOps[I, E, O, R] with Product with Serializable

I

Input parameter types.

E

Error output parameter types.

O

Output parameter types.

R

The capabilities that are required by this endpoint's inputs/outputs. Any, if no requirements.

F

The effect type used in the provided server logic.

Linear Supertypes
Serializable, Serializable, Product, Equals, EndpointMetaOps[I, E, O, R], EndpointInfoOps[I, E, O, R], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ServerEndpoint
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. EndpointMetaOps
  7. EndpointInfoOps
  8. AnyRef
  9. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new ServerEndpoint(endpoint: Endpoint[I, E, O, R], logic: (MonadError[F]) ⇒ (I) ⇒ F[Either[E, O]])

Type Members

  1. type EndpointType[_I, _E, _O, -_R] = ServerEndpoint[_I, _E, _O, _R, F]
    Definition Classes
    ServerEndpoint → EndpointMetaOps → EndpointInfoOps

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. def additionalInputsForShow: Vector[Basic[_]]
    Attributes
    protected
    Definition Classes
    EndpointMetaOps
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @HotSpotIntrinsicCandidate()
  7. def deprecated(): EndpointType[I, E, O, R]
    Definition Classes
    EndpointInfoOps
  8. def description(d: String): EndpointType[I, E, O, R]
    Definition Classes
    EndpointInfoOps
  9. val endpoint: Endpoint[I, E, O, R]
  10. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  11. def errorOutput: EndpointOutput[E]
    Definition Classes
    ServerEndpoint → EndpointMetaOps
  12. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  13. def info: EndpointInfo
    Definition Classes
    ServerEndpoint → EndpointMetaOps → EndpointInfoOps
  14. def info(i: EndpointInfo): EndpointType[I, E, O, R]
    Definition Classes
    EndpointInfoOps
  15. def input: EndpointInput[I]
    Definition Classes
    ServerEndpoint → EndpointMetaOps
  16. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  17. val logic: (MonadError[F]) ⇒ (I) ⇒ F[Either[E, O]]
  18. def name(n: String): EndpointType[I, E, O, R]
    Definition Classes
    EndpointInfoOps
  19. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  20. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  21. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  22. def output: EndpointOutput[O]
    Definition Classes
    ServerEndpoint → EndpointMetaOps
  23. 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.

    Definition Classes
    EndpointMetaOps
  24. def show: String

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

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

    Definition Classes
    EndpointMetaOps
  25. def showDetail: String

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

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

    Definition Classes
    EndpointMetaOps
  26. def showRaw: String

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

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

    Definition Classes
    EndpointMetaOps
  27. def showType: String
    Attributes
    protected
    Definition Classes
    ServerEndpoint → EndpointMetaOps
  28. def summary(s: String): EndpointType[I, E, O, R]
    Definition Classes
    EndpointInfoOps
  29. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  30. def tag(t: String): EndpointType[I, E, O, R]
    Definition Classes
    EndpointInfoOps
  31. def tags(ts: List[String]): EndpointType[I, E, O, R]
    Definition Classes
    EndpointInfoOps
  32. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  33. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  34. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] ) @Deprecated
    Deprecated

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from EndpointMetaOps[I, E, O, R]

Inherited from EndpointInfoOps[I, E, O, R]

Inherited from AnyRef

Inherited from Any

Ungrouped