Trait/Object

kantan.codecs

Decoder

Related Docs: object Decoder | package codecs

Permalink

trait Decoder[E, D, F, T] extends Serializable

Type class for types that can be decoded from other types.

E

encoded type - what to decode from.

D

decoded type - what to decode to.

F

failure type - how to represent errors.

T

tag type - used to specialise decoder instances, and usually where default implementations are declared.

Linear Supertypes
Serializable, Serializable, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Decoder
  2. Serializable
  3. Serializable
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def decode(e: E): Result[F, D]

    Permalink

    Decodes encoded data.

    Decodes encoded data.

    This method is safe, in that it won't throw for run-of-the-mill errors. Unrecoverable errors such as out of memory exceptions are still thrown, but that's considered valid exceptional cases, where incorrectly encoded data is just... normal.

    Callers that wish to fail fast and fail hard can use the unsafeDecode method instead.

  2. abstract def getClass(): Class[_]

    Permalink
    Definition Classes
    Any

Concrete Value Members

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

    Permalink
    Definition Classes
    Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    Any
  4. def andThen[FF, DD](f: (Result[F, D]) ⇒ Result[FF, DD]): Decoder[E, DD, FF, T]

    Permalink

    Creates a new Decoder instance by transforming raw results with the specified function.

    Creates a new Decoder instance by transforming raw results with the specified function.

    Most of the time, other combinators such as map should be preferred. andThen is mostly useful when one needs to turn failures into successes, and even then, recover or recoverWith are probably more directly useful.

  5. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  6. def contramapEncoded[EE](f: (EE) ⇒ E): Decoder[EE, D, F, T]

    Permalink

    Creates a new Decoder instance by transforming encoded values with the specified function.

  7. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    Any
  8. def hashCode(): Int

    Permalink
    Definition Classes
    Any
  9. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  10. def map[DD](f: (D) ⇒ DD): Decoder[E, DD, F, T]

    Permalink

    Creates a new Decoder instance by transforming successful results with the specified function.

    Creates a new Decoder instance by transforming successful results with the specified function.

    This differs from mapResult in that the transformation function cannot fail.

  11. def mapError[FF](f: (F) ⇒ FF): Decoder[E, D, FF, T]

    Permalink

    Creates a new Decoder instance by transforming errors with the specified function.

  12. def mapResult[DD](f: (D) ⇒ Result[F, DD]): Decoder[E, DD, F, T]

    Permalink

    Creates a new Decoder instance by transforming successful results with the specified function.

    Creates a new Decoder instance by transforming successful results with the specified function.

    This differs from map in that it allows the transformation function to fail.

  13. def recover[DD >: D](pf: PartialFunction[F, DD]): Decoder[E, DD, F, T]

    Permalink

    Creates a new Decoder instance by transforming some failures into successes with the specified function.

  14. def recoverWith[DD >: D, FF >: F](pf: PartialFunction[F, Result[FF, DD]]): Decoder[E, DD, FF, T]

    Permalink

    Creates a new Decoder instance by transforming some failures with the specified function.

  15. def tag[TT]: Decoder[E, D, F, TT]

    Permalink

    Changes the type with which the decoder is tagged.

    Changes the type with which the decoder is tagged.

    This makes it possible to share similar decoders across various libraries. Extracting values from strings, for example, is a common task for which the default implementation can be shared rather than copy / pasted.

    Annotations
    @SuppressWarnings()
  16. def toString(): String

    Permalink
    Definition Classes
    Any
  17. def unsafeDecode(e: E): D

    Permalink

    Decodes encoded data unsafely.

    Decodes encoded data unsafely.

    The main difference between this and decode is that the former throws exceptions when errors occur where the later safely encodes error conditions in its return type.

    decode should almost always be preferred, but this can be useful for code where crashing is an acceptable reaction to failure.

Inherited from Serializable

Inherited from Serializable

Inherited from Any

Ungrouped