Trait/Object

tapir

Codec

Related Docs: object Codec | package tapir

Permalink

trait Codec[T, M <: MediaType, R] extends Decode[R, T]

A pair of functions, one to encode a value of type T to a raw value of type R, and another one to decode.

Also contains meta-data on the schema of the value, the media type and the raw value type.

T

Type of the values which can be encoded / to which raw values can be decoded.

M

The media type of encoded values.

R

Type of the raw value to which values are encoded.

Self Type
Codec[T, M, R]
Annotations
@implicitNotFound( ... )
Linear Supertypes
Decode[R, T], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Codec
  2. Decode
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def decode(s: R): DecodeResult[T]

    Permalink
    Definition Classes
    Codec → Decode

  2. abstract def encode(t: T): R

    Permalink

  3. abstract def meta: CodecMeta[M, R]

    Permalink

Concrete Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  5. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  6. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  7. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  8. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  9. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any

  10. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  11. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  12. def map[TT](f: (T) ⇒ TT)(g: (TT) ⇒ T): Codec[TT, M, R]

    Permalink

  13. def mapDecode[TT](f: (T) ⇒ DecodeResult[TT])(g: (TT) ⇒ T): Codec[TT, M, R]

    Permalink

  14. def mediaType[M2 <: MediaType](m2: M2): Codec[T, M2, R]

    Permalink

  15. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  16. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  17. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  18. def safeDecode(f: R): DecodeResult[T]

    Permalink

    Calls decode and catches any exceptions that might occur, converting them to decode failures.

    Calls decode and catches any exceptions that might occur, converting them to decode failures.

    Definition Classes
    Decode

  19. def schema(s2: Schema): Codec[T, M, R]

    Permalink

  20. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef

  21. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any

  22. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  23. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  24. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Decode[R, T]

Inherited from AnyRef

Inherited from Any

Ungrouped