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.
- Alphabetic
- By Inheritance
- Endpoint
- Serializable
- Product
- Equals
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new Endpoint(input: EndpointInput[I], errorOutput: EndpointOutput[E], output: EndpointOutput[O], info: EndpointInfo)
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##(): Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- def connect: Endpoint[I, E, O, S]
- def delete: Endpoint[I, E, O, S]
- def description(d: String): Endpoint[I, E, O, S]
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def errorOut[F, EF](i: EndpointOutput[F])(implicit ts: typelevel.ParamConcat.Aux[E, F, EF]): Endpoint[I, EF, O, S]
- val errorOutput: EndpointOutput[E]
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- def get: Endpoint[I, E, O, S]
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def head: Endpoint[I, E, O, S]
- def in[J, IJ, S2 >: S](i: StreamingEndpointIO[J, S2])(implicit ts: typelevel.ParamConcat.Aux[I, J, IJ]): Endpoint[IJ, E, O, S2]
- def in[J, IJ](i: EndpointInput[J])(implicit ts: typelevel.ParamConcat.Aux[I, J, IJ]): Endpoint[IJ, E, O, S]
- def info(i: EndpointInfo): Endpoint[I, E, O, S]
- val info: EndpointInfo
- val input: EndpointInput[I]
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- def mapErrorOut[EE](f: (E) => EE)(g: (EE) => E): Endpoint[I, EE, O, S]
- def mapErrorOutTo[COMPANION, CASE_CLASS <: Product](c: COMPANION)(implicit fc: FnComponents[COMPANION, E, CASE_CLASS]): Endpoint[I, CASE_CLASS, O, S]
- def mapIn[II](f: (I) => II)(g: (II) => I): Endpoint[II, E, O, S]
- def mapInTo[COMPANION, CASE_CLASS <: Product](c: COMPANION)(implicit fc: FnComponents[COMPANION, I, CASE_CLASS]): Endpoint[CASE_CLASS, E, O, S]
- def mapOut[OO](f: (O) => OO)(g: (OO) => O): Endpoint[I, E, OO, S]
- def mapOutTo[COMPANION, CASE_CLASS <: Product](c: COMPANION)(implicit fc: FnComponents[COMPANION, O, CASE_CLASS]): Endpoint[I, E, CASE_CLASS, S]
- def method(m: String): Endpoint[I, E, O, S]
- def name(n: String): Endpoint[I, E, O, S]
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- def options: Endpoint[I, E, O, S]
- def out[P, OP, S2 >: S](i: StreamingEndpointIO[P, S2])(implicit ts: typelevel.ParamConcat.Aux[O, P, OP]): Endpoint[I, E, OP, S2]
- def out[P, OP](i: EndpointOutput[P])(implicit ts: typelevel.ParamConcat.Aux[O, P, OP]): Endpoint[I, E, OP, S]
- val output: EndpointOutput[O]
- def patch: Endpoint[I, E, O, S]
- def post: Endpoint[I, E, O, S]
- def prependErrorOut[F, FE](i: EndpointOutput[F])(implicit ts: typelevel.ParamConcat.Aux[F, E, FE]): Endpoint[I, FE, O, S]
- def prependIn[J, JI, S2 >: S](i: StreamingEndpointIO[J, S2])(implicit ts: typelevel.ParamConcat.Aux[J, I, JI]): Endpoint[JI, E, O, S2]
- def prependIn[J, JI](i: EndpointInput[J])(implicit ts: typelevel.ParamConcat.Aux[J, I, JI]): Endpoint[JI, E, O, S]
- def prependOut[P, PO](i: EndpointOutput[P])(implicit ts: typelevel.ParamConcat.Aux[P, O, PO]): Endpoint[I, E, PO, S]
- def productElementNames: Iterator[String]
- Definition Classes
- Product
- def put: Endpoint[I, E, O, S]
- def renderPathTemplate(renderPathParam: RenderPathParam = RenderPathTemplate.Defaults.path, renderQueryParam: Option[RenderQueryParam] = Some(RenderPathTemplate.Defaults.query), 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.
- def serverLogic[F[_]](f: (I) => F[Either[E, O]]): ServerEndpoint[I, E, O, S, F]
- def show: String
Basic information about the endpoint, excluding mapping information, with inputs sorted (first the method, then path, etc.)
- def showDetail: String
Detailed description of the endpoint, with inputs/outputs represented in the same order as originally defined, including mapping information.
- def showRaw: String
Equivalent to
.toString
, shows the whole case class structure. - def summary(s: String): Endpoint[I, E, O, S]
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def tag(t: String): Endpoint[I, E, O, S]
- def tags(ts: List[String]): Endpoint[I, E, O, S]
- def trace: Endpoint[I, E, O, S]
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()