Packages

  • package root
    Definition Classes
    root
  • package fs2
    Definition Classes
    root
  • package data
    Definition Classes
    fs2
  • package cbor
    Definition Classes
    data
  • package high

    High-level representation and tools for CBOR data streams.

    High-level representation and tools for CBOR data streams.

    The high-level representation is less powerful as the low-level one, as it builds structured data. For instance it is not able to represent arrays of strings whose size is bigger than Int.MaxValue.

    The reprensentation is intended to be easier to work with if you need more structured data and don't exceed the underlying limits.

    Definition Classes
    cbor
  • package internal
  • CborValue
  • HalfFloat
  • package low

    Low-level representation and tools for CBOR data streams.

    Low-level representation and tools for CBOR data streams.

    The low-level representation has two main goals:

    • it is a flat representation of the input stream, which allows for expressing collections that exceed the max size of Int.MaxValue
      • it doesn't interpret numbers, keeping their raw representation in memory.

    This representation is useful when dealing with streams that may contain big collections or when it is not necessary to build an AST, as it is more efficient than the high-level one.

    The data model follows closely the structure described in the RFC.

    Definition Classes
    cbor

package high

High-level representation and tools for CBOR data streams.

The high-level representation is less powerful as the low-level one, as it builds structured data. For instance it is not able to represent arrays of strings whose size is bigger than Int.MaxValue.

The reprensentation is intended to be easier to work with if you need more structured data and don't exceed the underlying limits.

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. high
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Package Members

  1. package internal

Type Members

  1. sealed trait CborValue extends AnyRef

Value Members

  1. def parseValues[F[_]](implicit F: RaiseThrowable[F]): Pipe[F, CborItem, CborValue]

    Parses the stream of low-level items into high level AST.

  2. def toBinary[F[_]]: Pipe[F, CborValue, Byte]

    Transforms a stream of CBOR values into the binary representations.

    Transforms a stream of CBOR values into the binary representations.

    This encoder, uses some tags defined in Tags to encode some values (e.g. big numbers).

  3. def toItems[F[_]]: Pipe[F, CborValue, CborItem]

    Transforms a stream of CBOR values into a stream of low-level items.

    Transforms a stream of CBOR values into a stream of low-level items.

    This encoder, uses some tags defined in Tags to encode some values (e.g. big numbers).

  4. def values[F[_]](implicit F: RaiseThrowable[F]): Pipe[F, Byte, CborValue]

    Parses the stream of bytes into high level AST.

  5. object CborValue
  6. object HalfFloat

    HalfFloat represents 16-bit floating-point values.

    HalfFloat represents 16-bit floating-point values.

    This type does not actually support arithmetic directly. The expected use case is to convert to Float to perform any actual arithmetic, then convert back to a HalfFloat if needed.

    Binary representation:

    sign (1 bit) | | exponent (5 bits) | | | | mantissa (10 bits) | | | x xxxxx xxxxxxxxxx

    Value interpretation (in order of precedence, with _ wild):

    0 00000 0000000000 (positive) zero 1 00000 0000000000 negative zero _ 00000 subnormal number _ 11111 0000000000 +/- infinity _ 11111 not-a-number _ _ normal number

    For non-zero exponents, the mantissa has an implied leading 1 bit, so 10 bits of data provide 11 bits of precision for normal numbers.

Inherited from AnyRef

Inherited from Any

Ungrouped