Trait

com.github.plokhotnyuk.jsoniter_scala.core

JsonCodec

Related Doc: package core

Permalink

trait JsonCodec[A] extends JsonValueCodec[A] with JsonKeyCodec[A]

A JsonCodec[A] instance is a universal codec for JSON values and keys.

Linear Supertypes
JsonKeyCodec[A], JsonValueCodec[A], Serializable, Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. JsonCodec
  2. JsonKeyCodec
  3. JsonValueCodec
  4. Serializable
  5. Serializable
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def decodeKey(in: JsonReader): A

    Permalink

    Attempts to decode a value of type A from the specified JsonReader, but may fail with JsonReaderException error if the JSON input is not a key or does not encode a value of this type.

    Attempts to decode a value of type A from the specified JsonReader, but may fail with JsonReaderException error if the JSON input is not a key or does not encode a value of this type.

    in

    an instance of JsonReader which provide an access to the JSON input to parse a JSON key to value of type A

    Definition Classes
    JsonKeyCodec

  2. abstract def decodeValue(in: JsonReader, default: A): A

    Permalink

    Attempts to decode a value of type A from the specified JsonReader, but may fail with JsonReaderException error if the JSON input does not encode a value of this type.

    Attempts to decode a value of type A from the specified JsonReader, but may fail with JsonReaderException error if the JSON input does not encode a value of this type.

    in

    an instance of JsonReader which provide an access to the JSON input to parse a JSON value to value of type A

    default

    the placeholder value provided to initialize some possible local variables

    Definition Classes
    JsonValueCodec

  3. abstract def encodeKey(x: A, out: JsonWriter): Unit

    Permalink

    Encodes the specified value using provided JsonWriter as a JSON key, but may fail with JsonWriterException if it cannot be encoded properly according to RFC-8259 requirements.

    Encodes the specified value using provided JsonWriter as a JSON key, but may fail with JsonWriterException if it cannot be encoded properly according to RFC-8259 requirements.

    x

    the value provided for serialization

    out

    an instance of JsonWriter which provides access to JSON output to serialize the specified value as a JSON key

    Definition Classes
    JsonKeyCodec

  4. abstract def encodeValue(x: A, out: JsonWriter): Unit

    Permalink

    Encodes the specified value using provided JsonWriter, but may fail with JsonWriterException if it cannot be encoded properly according to RFC-8259 requirements.

    Encodes the specified value using provided JsonWriter, but may fail with JsonWriterException if it cannot be encoded properly according to RFC-8259 requirements.

    x

    the value provided for serialization

    out

    an instance of JsonWriter which provides access to JSON output to serialize the specified value as a JSON value

    Definition Classes
    JsonValueCodec

  5. abstract def nullValue: A

    Permalink

    Returns some placeholder value that will be used by the high level code that generates codec instances to initialize local variables for parsed field values which have a codec that was injected using implicit val.

    Returns some placeholder value that will be used by the high level code that generates codec instances to initialize local variables for parsed field values which have a codec that was injected using implicit val.

    See the jsoniter-scala-macros sub-project code and its tests for usages of .nullValue calls.

    Definition Classes
    JsonValueCodec

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. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  13. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  14. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

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

    Permalink
    Definition Classes
    AnyRef

  16. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any

  17. final def wait(): Unit

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

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

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

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

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

Inherited from JsonKeyCodec[A]

Inherited from JsonValueCodec[A]

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped