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

A Codec which can encode to optional raw values / decode from optional *raw* values. An optional raw value specifies if the raw value should be included in the output, or not. Depending on the codec, decoding from an optional value might yield DecodeResult.Missing.

Should be used for inputs/outputs which can be mapped to an optional value.

The main difference comparing to Codec is the signature of the encode and rawDecode methods. For each Codec, a CodecForOptional can be derived.

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

Abstract Value Members

  1. abstract def encode(t: T): Option[R]
  2. abstract def meta: CodecMeta[T, M, R]
  3. abstract def rawDecode(s: Option[R]): DecodeResult[T]
    Definition Classes
    CodecForOptional → Decode

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( ... ) @native()
  6. def decode(f: Option[R]): DecodeResult[T]

    - calls rawDecode - catches any exceptions that might occur, converting them to decode failures - validates the result

    - calls rawDecode - catches any exceptions that might occur, converting them to decode failures - validates the result

    Definition Classes
    Decode
  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  9. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  10. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  11. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  12. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  13. def map[TT](f: (T) ⇒ TT)(g: (TT) ⇒ T): CodecForOptional[TT, M, R]
  14. def mapDecode[TT](f: (T) ⇒ DecodeResult[TT])(g: (TT) ⇒ T): CodecForOptional[TT, M, R]
  15. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  16. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  17. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  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]): CodecForOptional[T, M, R]
  21. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  22. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  23. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()

Inherited from Decode[T, Option[R]]

Inherited from AnyRef

Inherited from Any

Ungrouped