sealed trait EndpointTransput[T] extends EndpointTransputMacros[T]

A transput is EITHER an input, or an output (see: https://ell.stackexchange.com/questions/21405/hypernym-for-input-and-output). The transput traits contain common functionality, shared by all inputs and outputs.

Note that implementations of EndpointIO can be used *both* as inputs and outputs.

The hierarchy is as follows:

                        /---> `EndpointInput`  >---\
`EndpointTransput` >---                            ---> `EndpointIO`
                        \---> `EndpointOutput` >---/

Inputs and outputs additionally form another hierarchy:

                                      /--> `Single` >--> `Basic` >--> `Atom`
`EndpointInput` / `EndpointOutput` >--
                                      \--> `Pair`

where the intuition behind the traits is:

  • single: represents a single value, as opposed to a pair (tuple); a pair, but transformed using .map is also a single value
  • basic: corresponds to an input/output which is encoded/decoded in one step; always single
  • atom: corresponds to a single component of a request or response. Such inputs/outputs contain a Codec and Info meta-data, and are always basic
Linear Supertypes
EndpointTransputMacros[T], AnyRef, Any
Known Subclasses
EndpointIO, Atom, Basic, Body, Empty, FixedHeader, Header, Headers, MappedPair, OneOfBody, Pair, Single, StreamBodyWrapper, EndpointInput, Atom, Auth, Basic, Cookie, ExtractFromRequest, FixedMethod, FixedPath, MappedPair, Pair, PathCapture, PathsCapture, Query, QueryParams, Single, EndpointOutput, Atom, Basic, FixedStatusCode, MappedPair, OneOf, Pair, Single, StatusCode, Void, WebSocketBodyWrapper, Atom, Basic, Pair, StreamBodyIO, WebSocketBodyOutput
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. EndpointTransput
  2. EndpointTransputMacros
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

  1. abstract def map[U](mapping: Mapping[T, U]): ThisType[U]
  2. abstract def show: String

Concrete 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(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  9. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  10. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  11. def map[U](f: (T) => U)(g: (U) => T): ThisType[U]
  12. def mapDecode[U](f: (T) => DecodeResult[U])(g: (U) => T): ThisType[U]
  13. macro def mapTo[CASE_CLASS]: ThisType[CASE_CLASS]
    Definition Classes
    EndpointTransputMacros
  14. def mapValidate[U](v: Validator[T])(f: (T) => U)(g: (U) => T): ThisType[U]

    Adds the given validator, and maps to the given higher-level type U.

    Adds the given validator, and maps to the given higher-level type U.

    Unlike a .validate(v).map(f)(g) invocation, during decoding the validator is run before applying the f function. If there are validation errors, decoding fails. However, the validator is then invoked again on the fully decoded value.

    This is useful to create inputs/outputs for types, which are unrepresentable unless the validator's condition is met, e.g. due to preconditions in the constructor.

    See also

    validate

  15. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  16. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  17. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  18. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  19. def toString(): String
    Definition Classes
    AnyRef → Any
  20. def validate(v: Validator[T]): ThisType[T]

    Adds a validator.

    Adds a validator.

    Note that validation is run on a fully decoded value. That is, during decoding, first the decoding functions are run, followed by validations. Hence any functions provided in subsequent .maps or .mapDecodes will be invoked before validation.

    See also

    mapValidate

  21. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  22. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  23. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

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

Inherited from EndpointTransputMacros[T]

Inherited from AnyRef

Inherited from Any

Ungrouped