Trait

quasar.precog.common.Codec

FixedWidthCodec

Related Doc: package Codec

Permalink

trait FixedWidthCodec[A] extends Codec[A]

Linear Supertypes
Codec[A], AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. FixedWidthCodec
  2. Codec
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. type S = A

    Permalink
    Definition Classes
    FixedWidthCodecCodec

Abstract Value Members

  1. abstract def read(buffer: ByteBuffer): A

    Permalink

    Reads a value of type A from buffer.

    Reads a value of type A from buffer. This should generally follow the contract that writeUnsafe(a, buffer); read(buffer) == a.

    Definition Classes
    Codec
  2. abstract def size: Int

    Permalink
  3. abstract def writeUnsafe(a: A, buffer: ByteBuffer): Unit

    Permalink

    Performs an *unsafe* write of a to buffer.

    Performs an *unsafe* write of a to buffer. This does not perform any safety checks and assumes buffer has at least encodedSize(a) bytes remaining. The behaviour if this is not the case is undefined.

    Definition Classes
    Codec

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. def as[B](to: (B) ⇒ A, from: (A) ⇒ B): Codec[B]

    Permalink
    Definition Classes
    Codec
  5. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  6. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  7. def encodedSize(a: A): Int

    Permalink

    Returns the exact encoded size of a.

    Returns the exact encoded size of a.

    Definition Classes
    FixedWidthCodecCodec
  8. final def eq(arg0: AnyRef): Boolean

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

    Permalink
    Definition Classes
    AnyRef → Any
  10. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  11. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  12. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  13. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  14. def maxSize(a: A): Int

    Permalink

    Returns an upper bound on the size of a.

    Returns an upper bound on the size of a.

    Definition Classes
    FixedWidthCodecCodec
  15. def minSize(a: A): Int

    Permalink

    Returns a lower bound on the space required in a buffer so that a can be written.

    Returns a lower bound on the space required in a buffer so that a can be written.

    Definition Classes
    FixedWidthCodecCodec
  16. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  17. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  18. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  19. def skip(buf: ByteBuffer): Unit

    Permalink

    This is similar to read(buffer), except that a value does not actually need to be returned.

    This is similar to read(buffer), except that a value does not actually need to be returned.

    Definition Classes
    FixedWidthCodecCodec
  20. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  21. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  22. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  23. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  24. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  25. def write[M[_]](a: A)(implicit M: ByteBufferMonad[M]): M[Unit]

    Permalink

    Writes a using a ByteBufferMonad.

    Writes a using a ByteBufferMonad. This is much slower than just using writeInit/writeMore.

    Definition Classes
    Codec
  26. def writeAll(a: A)(acquire: () ⇒ ByteBuffer, used: List[ByteBuffer] = Nil): List[ByteBuffer]

    Permalink

    Writes a entirely to a series of ByteBuffers returned by acquire.

    Writes a entirely to a series of ByteBuffers returned by acquire. The returned set of ByteBuffers is in reverse order, so that calls to writeAll can be chained by passing in the previous result to used.

    Definition Classes
    Codec
  27. def writeInit(a: A, b: ByteBuffer): Option[A]

    Permalink

    Initiate a write.

    Initiate a write. If a is successfully written (in its entirety) to buffer, then None is returned. Otherwise, Some(s) is returned, indicating that some more data (ie. s) still needs to be written using writeMore(s, _). This last condition will normally happen when we run out of space in the buffer, so a was only partially written.

    Definition Classes
    FixedWidthCodecCodec
  28. def writeMore(a: A, b: ByteBuffer): Option[A]

    Permalink

    Writes the remaining data from a call to writeInit to buffer.

    Writes the remaining data from a call to writeInit to buffer. If this is written completely and successfully, None is returned. Otherwise, Some(s2) is returned, which contains more data to be written with writeMore.

    Definition Classes
    FixedWidthCodecCodec

Inherited from Codec[A]

Inherited from AnyRef

Inherited from Any

Ungrouped