Trait

com.avsystem.commons.serialization

Input

Related Doc: package serialization

Permalink

trait Input extends Any

Represents an abstract source from which a value may be deserialized (read). Each of the read methods returns an instance of ValueRead which may contain either a successfully read value or an error message.

An Input value should be assumed to be stateful. If any of the read methods have already been called AND returned successful result ((ReadSuccessful), the Input instance can no longer be used and MUST be discarded. On the other hand, when the read method returned a ReadFailed, its state should be unchanged and any read method may be called again.

In order to ignore the value kept in this Input, skip() MUST be called.

In summary: every Input MUST be fully exhausted by either calling one of the read methods which returns successful value or by calling skip(). Also, ListInput and ObjectInput instances returned from this Input must also be fully exhausted on their own.

Linear Supertypes
Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Input
  2. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

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

    Permalink
    Definition Classes
    Any
  2. abstract def readBinary(): ValueRead[Array[Byte]]

    Permalink
  3. abstract def readBoolean(): ValueRead[Boolean]

    Permalink
  4. abstract def readDouble(): ValueRead[Double]

    Permalink
  5. abstract def readInt(): ValueRead[Int]

    Permalink
  6. abstract def readList(): ValueRead[ListInput]

    Permalink
  7. abstract def readLong(): ValueRead[Long]

    Permalink
  8. abstract def readNull(): ValueRead[Null]

    Permalink
  9. abstract def readObject(): ValueRead[ObjectInput]

    Permalink
  10. abstract def readString(): ValueRead[String]

    Permalink
  11. abstract def skip(): Unit

    Permalink

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. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  5. def equals(arg0: Any): Boolean

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

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

    Permalink
    Definition Classes
    Any
  8. def readByte(): ValueRead[Byte]

    Permalink
  9. def readChar(): ValueRead[Char]

    Permalink
  10. def readFloat(): ValueRead[Float]

    Permalink
  11. def readMap(): ValueRead[ObjectInput]

    Permalink
  12. def readSet(): ValueRead[ListInput]

    Permalink
  13. def readShort(): ValueRead[Short]

    Permalink
  14. def readTimestamp(): ValueRead[Long]

    Permalink
  15. def readUnit(): ValueRead[Unit]

    Permalink
  16. def toString(): String

    Permalink
    Definition Classes
    Any

Inherited from Any

Ungrouped