Packages

trait FieldInput extends Input

An Input representing an object field. The same as Input but also provides field name.

Linear Supertypes
Input, AnyRef, Any
Known Subclasses
HoconFieldInput, BsonReaderFieldInput, RedisFieldDataInput, SimpleValueFieldInput, StreamFieldInput, CborFieldInput, JsonStringFieldInput
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. FieldInput
  2. Input
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def fieldName: String
  2. abstract def readList(): ListInput
    Definition Classes
    Input
  3. abstract def readNull(): Boolean

    Attempts to read null value from an Input.

    Attempts to read null value from an Input. Returning true means that input instance contained a null value. Its state should then be changed so that input can be considered "consumed" (no other reads are possible on this instance). Returning false means that the input contains something else than a null value. Its state must not change in this situation and it must be possible to call some other read method on it.

    Definition Classes
    Input
  4. abstract def readObject(): ObjectInput
    Definition Classes
    Input
  5. abstract def readSimple(): SimpleInput
    Definition Classes
    Input
  6. abstract def skip(): Unit

    Ignores this input and skips its contents internally, if necessary

    Ignores this input and skips its contents internally, if necessary

    Definition Classes
    Input

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[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  8. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  9. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  10. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  11. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  12. def legacyOptionEncoding: Boolean

    This ugly workaround has been introduced when standard Option encoding changed from zero-or-one element list encoding to unwrapped-or-null encoding which effectively disallowed serializing null and Some(null).

    This ugly workaround has been introduced when standard Option encoding changed from zero-or-one element list encoding to unwrapped-or-null encoding which effectively disallowed serializing null and Some(null). If some Input implementation still wants to use the list encoding, it may do it by overriding this method and returning true.

    Definition Classes
    Input
  13. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  15. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  16. def readCustom[T](typeMarker: TypeMarker[T]): commons.Opt[T]

    Attempts to read some arbitrary custom "native" value that this input may or may not support.

    Attempts to read some arbitrary custom "native" value that this input may or may not support. The custom type is identified by an instance of TypeMarker which is usually an object (e.g. companion object of the custom T type itself). This way Input and Output implementations may support other native types than the ones supported by default by Input and Output interfaces.

    Codecs may use this method to optimize encoded format in case it it possible with particular Input implementation. GenCodec may generally assume that if the data was written by a corresponding Output which also support this custom native type then readCustom should return non-empty value.

    Opt.Empty returned by this method indicates that this input does not support this particular type. If it supports it but there was some error reading it then a ReadFailure should be thrown instead of returning Opt.Empty.

    Definition Classes
    Input
  17. def readMetadata[T](metadata: InputMetadata[T]): commons.Opt[T]

    Attempts to read some arbitrary "metadata" about this input instance.

    Attempts to read some arbitrary "metadata" about this input instance. Metadata is identified by InputMetadata which is usually an object (e.g. companion object of metadata value type T). An example of InputMetadata is JsonType supported by JsonStringInput.

    Codecs may use this method to optimize encoded format in case it it possible with particular Input implementation. GenCodec may generally assume that if the data was written by a corresponding Output that preserves particular metadata type (which may be determined by Output.keepsMetadata()) then readMetadata will return a non-empty value.

    Opt.Empty may be returned form this method ONLY if this Input implementation does not support this metadata type AT ALL. Any errors should be signaled by throwing ReadFailure.

    Definition Classes
    Input
  18. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  19. def toString(): String
    Definition Classes
    AnyRef → Any
  20. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  21. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  22. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )

Inherited from Input

Inherited from AnyRef

Inherited from Any

Ungrouped