scodec.codecs

ChecksumCodec

Related Doc: package codecs

object ChecksumCodec

Provides methods to create a "checksum codec" (encodes a bit-range to a bit-checksum and decodes bits to a bit-range).

Source
ChecksumCodec.scala
Linear Supertypes
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. ChecksumCodec
  2. AnyRef
  3. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Type Members

  1. case class Mismatch(bits: BitVector, expected: BitVector, actual: BitVector, context: List[String] = Nil) extends Err with Product with Serializable

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. def apply(length: Int, f: (ByteVector) ⇒ ByteVector, range: Decoder[Int], padding: Int): Codec[BitVector]

    Returns a codec that encodes a bit-range to a bit-checksum and decodes bits to a bit-range.

    Returns a codec that encodes a bit-range to a bit-checksum and decodes bits to a bit-range.

    length

    the byte-length of the checksum

    f

    computes byte-checksum

    range

    decodes the (un-padded) size of a byte-range

    padding

    size padding for the byte-range

    returns

  5. def apply(length: Long, f: (BitVector) ⇒ BitVector, range: Decoder[Long], padding: Long): Codec[BitVector]

    Returns a codec that encodes a bit-range to a bit-checksum and decodes bits to a bit-range.

    Returns a codec that encodes a bit-range to a bit-checksum and decodes bits to a bit-range.

    length

    the bit-length of the checksum

    f

    computes bit-checksum

    range

    decodes the (un-padded) size of a bit-range

    padding

    size padding for the bit-range

    returns

  6. def apply(encoder: Encoder[ByteVector], range: Decoder[Int], padding: Int): Codec[BitVector]

    Returns a codec that encodes a bit-range to a bit-checksum and decodes bits to a bit-range.

    Returns a codec that encodes a bit-range to a bit-checksum and decodes bits to a bit-range.

    encoder

    encodes a byte-range to a byte-checksum

    range

    decodes the (un-padded) size of a byte-range

    padding

    size padding for the byte-range

    returns

  7. def apply(encoder: Encoder[BitVector], range: Decoder[Long], padding: Long): Codec[BitVector]

    Returns a codec that encodes a bit-range to a bit-checksum and decodes bits to a bit-range.

    Returns a codec that encodes a bit-range to a bit-checksum and decodes bits to a bit-range.

    encoder

    encodes a bit-range to a bit-checksum

    range

    decodes the (un-padded) size of a bit-range

    padding

    size padding for the bit-range

    returns

  8. def apply(encoder: Encoder[BitVector], range: Decoder[Long]): Codec[BitVector]

    Returns a codec that encodes a bit-range to a bit-checksum and decodes bits to a bit-range.

    Returns a codec that encodes a bit-range to a bit-checksum and decodes bits to a bit-range.

    encoder

    encodes a bit-range to a bit-checksum

    range

    decodes the size of a bit-range

    returns

  9. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  10. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  11. final def eq(arg0: AnyRef): Boolean

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

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

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

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

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

    Definition Classes
    Any
  17. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  18. final def notify(): Unit

    Definition Classes
    AnyRef
  19. final def notifyAll(): Unit

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

    Definition Classes
    AnyRef
  21. def toString(): String

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

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  25. def xor(length: Int, range: Decoder[Int], padding: Int): Codec[BitVector]

    Returns a codec that encodes a bit-range to an XORed bit-checksum and decodes bits to a bit-range.

    Returns a codec that encodes a bit-range to an XORed bit-checksum and decodes bits to a bit-range.

    length

    the byte-length of the checksum

    range

    decodes the (un-padded) size of a byte-range

    padding

    size padding for the byte-range

    returns

  26. def xor(length: Long, range: Decoder[Long], padding: Long): Codec[BitVector]

    Returns a codec that encodes a bit-range to an XORed bit-checksum and decodes bits to a bit-range.

    Returns a codec that encodes a bit-range to an XORed bit-checksum and decodes bits to a bit-range.

    length

    the bit-length of the checksum

    range

    decodes the (un-padded) size of a bit-range

    padding

    size padding for the bit-range

    returns

Inherited from AnyRef

Inherited from Any

Ungrouped