Packages

c

co.topl.utils.serialization

VLQByteStringReader

class VLQByteStringReader extends VLQReader

Linear Supertypes
VLQReader, Reader, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. VLQByteStringReader
  2. VLQReader
  3. Reader
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new VLQByteStringReader(byteString: ByteString)

Type Members

  1. type CH = ByteString

    Type of encoded data

    Type of encoded data

    Definition Classes
    VLQByteStringReader → Reader

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(classOf[java.lang.CloneNotSupportedException]) @native()
  6. def consumed: Int

    Returns the number of decoded elements

    Returns the number of decoded elements

    returns

    The number of decoded elements

    Definition Classes
    VLQByteStringReader → Reader
    Annotations
    @inline()
  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  9. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  10. def getBits(size: Int): Array[Boolean]

    Decode array of boolean values

    Decode array of boolean values

    size

    expected size of decoded array

    returns

    decoded array of boolean values

    Definition Classes
    VLQReader → Reader
    Annotations
    @inline()
  11. def getBoolean(): Boolean

    Decode a boolean

    Decode a boolean

    returns

    boolean

    Definition Classes
    VLQByteStringReader → Reader
    Annotations
    @inline()
  12. def getByte(): Byte

    Decode signed byte

    Decode signed byte

    returns

    Byte

    Definition Classes
    VLQByteStringReader → Reader
    Annotations
    @inline()
  13. def getByteString(): String

    Decode String is shorter than 256 bytes

    Decode String is shorter than 256 bytes

    Definition Classes
    VLQReader → Reader
    Annotations
    @inline()
  14. def getBytes(size: Int): Array[Byte]

    Decode array of byte values

    Decode array of byte values

    size

    expected size of decoded array

    Definition Classes
    VLQByteStringReader → Reader
    Annotations
    @inline()
  15. def getChunk(size: Int): ByteString

    Returns encoded data at current position

    Returns encoded data at current position

    Definition Classes
    VLQByteStringReader → Reader
    Annotations
    @inline()
  16. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  17. def getInt(): Int

    Decode signed Int previously encoded with VLQWriter.putInt using VLQ with ZigZag.

    Decode signed Int previously encoded with VLQWriter.putInt using VLQ with ZigZag.

    returns

    signed Int

    Definition Classes
    VLQReader → Reader
    Annotations
    @inline()
    Note

    Uses ZigZag encoding. Should be used to decode only a value that was previously encoded with VLQByteBufferWriter.putInt.

    See also

    https://en.wikipedia.org/wiki/Variable-length_quantity

  18. def getInt128(): Int128

    Retrieve the custom Int128 type that is 16 bytes (128 bits)

    Retrieve the custom Int128 type that is 16 bytes (128 bits)

    returns

    signed Int128

    Definition Classes
    VLQReader → Reader
    Annotations
    @inline()
  19. def getIntString(): String

    Decode String is greater than 256 bytes

    Decode String is greater than 256 bytes

    Definition Classes
    VLQReader → Reader
    Annotations
    @inline()
  20. def getLong(): Long

    Decode signed Long previously encoded with VLQWriter.putLong using VLQ with ZigZag.

    Decode signed Long previously encoded with VLQWriter.putLong using VLQ with ZigZag.

    returns

    signed Long

    Definition Classes
    VLQReader → Reader
    Annotations
    @inline()
    Note

    Uses ZigZag encoding. Should be used to decode only a value that was previously encoded with VLQWriter.putLong.

    See also

    https://en.wikipedia.org/wiki/Variable-length_quantity

  21. def getOption[T](getValue: => T): Option[T]

    Decode optional value

    Decode optional value

    getValue

    function to decode value, if optional value is nonempty

    returns

    optional value

    Definition Classes
    VLQReader → Reader
    Annotations
    @inline()
  22. def getShort(): Short

    Decode signed Short previously encoded with VLQWriter.putShort using VLQ and then ZigZag.

    Decode signed Short previously encoded with VLQWriter.putShort using VLQ and then ZigZag.

    returns

    signed Short

    Definition Classes
    VLQReader → Reader
    Annotations
    @inline()
    Note

    Uses VLQ and then ZigZag encoding. Should be used to decode only a value that was previously encoded with VLQByteBufferWriter.putShort.

    See also

    https://en.wikipedia.org/wiki/Variable-length_quantity

  23. def getUByte(): Int

    Decode positive Byte

    Decode positive Byte

    returns

    signed Int

    Definition Classes
    VLQReader → Reader
    Annotations
    @inline()
  24. def getUInt(): Long

    Decode Int previously encoded with VLQWriter.putUInt using VLQ.

    Decode Int previously encoded with VLQWriter.putUInt using VLQ.

    returns

    Long

    Definition Classes
    VLQReader → Reader
    Annotations
    @inline()
    See also

    https://en.wikipedia.org/wiki/Variable-length_quantity

  25. def getULong(): Long

    Decode Long previously encoded with VLQWriter.putULong using VLQ.

    Decode Long previously encoded with VLQWriter.putULong using VLQ.

    returns

    Long

    Definition Classes
    VLQReader → Reader
    Annotations
    @inline()
    See also

    https://en.wikipedia.org/wiki/Variable-length_quantity

  26. def getUShort(): Int

    Decode Short previously encoded with VLQWriter.putUShort using VLQ.

    Decode Short previously encoded with VLQWriter.putUShort using VLQ.

    returns

    Int throws AssertionError for deserialized values not in unsigned Short range

    Definition Classes
    VLQReader → Reader
    Annotations
    @inline()
    See also

    https://en.wikipedia.org/wiki/Variable-length_quantity

  27. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  28. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  29. def mark(): VLQByteStringReader.this.type

    Sets the mark to current position

    Sets the mark to current position

    Definition Classes
    VLQByteStringReader → Reader
    Annotations
    @inline()
  30. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  31. def newReader(chunk: ByteString): Aux[CH]

    Creates new instance of this Reader

    Creates new instance of this Reader

    chunk

    encoded data

    Definition Classes
    VLQByteStringReader → Reader
    Annotations
    @inline()
  32. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  33. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  34. def peekByte(): Byte

    Get a byte at current position without advancing the position.

    Get a byte at current position without advancing the position.

    returns

    byte at current position

    Definition Classes
    VLQByteStringReader → Reader
    Annotations
    @inline()
  35. def position: Int

    Returns current position

    Returns current position

    returns

    position

    Definition Classes
    VLQByteStringReader → Reader
    Annotations
    @inline()
  36. def position_=(p: Int): Unit

    Sets position

    Sets position

    p

    position

    Definition Classes
    VLQByteStringReader → Reader
    Annotations
    @inline()
  37. def remaining: Int

    Returns the number of elements between the current position and the end of Reader

    Returns the number of elements between the current position and the end of Reader

    returns

    The number of elements remaining in th Reader

    Definition Classes
    VLQByteStringReader → Reader
    Annotations
    @inline()
  38. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  39. def toString(): String
    Definition Classes
    AnyRef → Any
  40. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  41. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  42. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Inherited from VLQReader

Inherited from Reader

Inherited from AnyRef

Inherited from Any

Ungrouped