trait EndpointServerLogicOps[A, I, E, O, -R] extends AnyRef
- Alphabetic
- By Inheritance
- EndpointServerLogicOps
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
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() @HotSpotIntrinsicCandidate()
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- def serverLogic[F[_]](f: (I) => F[Either[E, O]])(implicit aIsUnit: =:=[A, Unit]): Full[Unit, Unit, I, E, O, R, F]
Combine this public endpoint description with a function, which implements the server-side logic.
Combine this public endpoint description with a function, which implements the server-side logic. The logic returns a result, which is either an error or a successful output, wrapped in an effect type
F
. For secure endpoints, use serverSecurityLogic.A server endpoint can be passed to a server interpreter. Each server interpreter supports effects of a specific type(s).
Both the endpoint and logic function are considered complete, and cannot be later extended through the returned ServerEndpoint value (except for endpoint meta-data). Secure endpoints allow providing the security logic before all the inputs and outputs are specified.
- def serverLogicError[F[_]](f: (I) => F[E])(implicit aIsUnit: =:=[A, Unit]): Full[Unit, Unit, I, E, O, R, F]
Like serverLogic, but specialised to the case when the result is always an error (
Left
), hence when the logic type can be simplified toI => F[E]
. - def serverLogicOption[F[_]](f: (I) => F[Option[O]])(implicit aIsUnit: =:=[A, Unit], eIsUnit: =:=[E, Unit]): Full[Unit, Unit, I, Unit, O, R, F]
Like serverLogic, but specialised to the case when the error type is
Unit
(e.g.Like serverLogic, but specialised to the case when the error type is
Unit
(e.g. a fixed status code), and the result of the logic function is an option. ANone
is then treated as an error response. - def serverLogicPure[F[_]](f: (I) => Either[E, O])(implicit aIsUnit: =:=[A, Unit]): Full[Unit, Unit, I, E, O, R, F]
Like serverLogic, but specialised to the case when the logic function is pure, that is doesn't have any side effects.
- def serverLogicRecoverErrors[F[_]](f: (I) => F[O])(implicit eIsThrowable: <:<[E, Throwable], eClassTag: ClassTag[E], aIsUnit: =:=[A, Unit]): Full[Unit, Unit, I, E, O, R, F]
Same as serverLogic, but requires
E
to be a throwable, and converts failed effects of typeE
to endpoint errors. - def serverLogicSuccess[F[_]](f: (I) => F[O])(implicit aIsUnit: =:=[A, Unit]): Full[Unit, Unit, I, E, O, R, F]
Like serverLogic, but specialised to the case when the result is always a success (
Right
), hence when the logic type can be simplified toI => F[O]
. - def serverSecurityLogic[PRINCIPAL, F[_]](f: (A) => F[Either[E, PRINCIPAL]]): PartialServerEndpoint[A, PRINCIPAL, I, E, O, R, F]
Combine this endpoint description with a function, which implements the security logic of the endpoint.
Combine this endpoint description with a function, which implements the security logic of the endpoint.
Subsequently, the endpoint inputs and outputs can be extended (for error outputs, new variants can be added, but they cannot be arbitrarily extended). Then the main server logic can be provided, given a function which accepts as arguments the result of the security logic and the remaining input. The final result is then a ServerEndpoint.
A complete server endpoint can be passed to a server interpreter. Each server interpreter supports effects of a specific type(s).
An example use-case is defining an endpoint with fully-defined errors, and with security logic built-in. Such an endpoint can be then extended by multiple other endpoints, by specifying different inputs, outputs and the main logic.
- def serverSecurityLogicError[PRINCIPAL, F[_]](f: (A) => F[E]): PartialServerEndpoint[A, PRINCIPAL, I, E, O, R, F]
Like serverSecurityLogic, but specialised to the case when the result is always an error (
Left
), hence when the logic type can be simplified toA => F[E]
. - def serverSecurityLogicOption[PRINCIPAL, F[_]](f: (A) => F[Option[PRINCIPAL]])(implicit eIsUnit: =:=[E, Unit]): PartialServerEndpoint[A, PRINCIPAL, I, Unit, O, R, F]
Like serverSecurityLogic, but specialised to the case when the error type is
Unit
(e.g.Like serverSecurityLogic, but specialised to the case when the error type is
Unit
(e.g. a fixed status code), and the result of the logic function is an option. ANone
is then treated as an error response. - def serverSecurityLogicOptionWithOutput[PRINCIPAL, F[_]](f: (A) => F[Option[(O, PRINCIPAL)]])(implicit eIsUnit: =:=[E, Unit]): PartialServerEndpointWithSecurityOutput[A, PRINCIPAL, I, Unit, O, Unit, R, F]
Like serverSecurityLogicWithOutput, but specialised to the case when the error type is
Unit
(e.g.Like serverSecurityLogicWithOutput, but specialised to the case when the error type is
Unit
(e.g. a fixed status code), and the result of the logic function is an option. ANone
is then treated as an error response. - def serverSecurityLogicPure[PRINCIPAL, F[_]](f: (A) => Either[E, PRINCIPAL]): PartialServerEndpoint[A, PRINCIPAL, I, E, O, R, F]
Like serverSecurityLogic, but specialised to the case when the logic function is pure, that is doesn't have any side effects.
- def serverSecurityLogicPureWithOutput[PRINCIPAL, F[_]](f: (A) => Either[E, (O, PRINCIPAL)]): PartialServerEndpointWithSecurityOutput[A, PRINCIPAL, I, E, O, Unit, R, F]
Like serverSecurityLogicWithOutput, but specialised to the case when the logic function is pure, that is doesn't have any side effects.
- def serverSecurityLogicRecoverErrors[PRINCIPAL, F[_]](f: (A) => F[PRINCIPAL])(implicit eIsThrowable: <:<[E, Throwable], eClassTag: ClassTag[E]): PartialServerEndpoint[A, PRINCIPAL, I, E, O, R, F]
Same as serverSecurityLogic, but requires
E
to be a throwable, and converts failed effects of typeE
to endpoint errors. - def serverSecurityLogicRecoverErrorsWithOutput[PRINCIPAL, F[_]](f: (A) => F[(O, PRINCIPAL)])(implicit eIsThrowable: <:<[E, Throwable], eClassTag: ClassTag[E]): PartialServerEndpointWithSecurityOutput[A, PRINCIPAL, I, E, O, Unit, R, F]
Same as serverSecurityLogicWithOutput, but requires
E
to be a throwable, and converts failed effects of typeE
to endpoint errors. - def serverSecurityLogicSuccess[PRINCIPAL, F[_]](f: (A) => F[PRINCIPAL]): PartialServerEndpoint[A, PRINCIPAL, I, E, O, R, F]
Like serverSecurityLogic, but specialised to the case when the result is always a success (
Right
), hence when the logic type can be simplified toA => F[PRINCIPAL]
. - def serverSecurityLogicSuccessWithOutput[PRINCIPAL, F[_]](f: (A) => F[(O, PRINCIPAL)]): PartialServerEndpointWithSecurityOutput[A, PRINCIPAL, I, E, O, Unit, R, F]
Like serverSecurityLogicWithOutput, but specialised to the case when the result is always a success (
Right
), hence when the logic type can be simplified toA => F[(O, PRINCIPAL)]
. - def serverSecurityLogicWithOutput[PRINCIPAL, F[_]](f: (A) => F[Either[E, (O, PRINCIPAL)]]): PartialServerEndpointWithSecurityOutput[A, PRINCIPAL, I, E, O, Unit, R, F]
Like serverSecurityLogic, but allows the security function to contribute to the overall output of the endpoint.
Like serverSecurityLogic, but allows the security function to contribute to the overall output of the endpoint. A value for the complete output
O
defined so far has to be provided. The valuePRINCIPAL
will be propagated as an input to the regular logic. - final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- 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()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
Deprecated Value Members
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated
- Deprecated