Decoders

A flattened representation of a term, which is independent of any underlying binary representation, but which we later serialise into CBOR format.

Since: cborg-0.2.0.0

Get access to the current version being used in the encoder

Ignore the current version of the encoder and enforce the supplied one instead.

Conditionoly choose the encoder newer or older deceder, depending on the current version. Supplied version acts as a pivot.

Example

Alternative way to encode a Maybe type.

Note - this is not the default method for encoding Maybe, use encodeMaybe instead

Alternative way to encode a Maybe type.

Note - this is not the default method for encoding StrictMaybe, use encodeStrictMaybe instead

Encode a rational number with tag 30, as per tag assignment: https://www.iana.org/assignments/cbor-tags/cbor-tags.xhtml

https://peteroupc.github.io/CBOR/rational.html

Encode a list. Versions variance:

• [>= 2] - Variable length encoding for lists longer than 23 elements, otherwise exact length encoding
• [< 2] - Variable length encoding

Encode a Seq. Variable length encoding for Sequences larger than 23 elements, otherwise exact length encoding

Encode a Set. Versions variance:

• [>= 9] - Variable length encoding for Sets larger than 23 elements, otherwise exact length encoding. Prefixes with a special 258 setTag.
• [>= 2] - Variable length encoding for Sets larger than 23 elements, otherwise exact length encoding
• [< 2] - Variable length encoding. Prefixes with a special 258 setTag.

Encode a Map. Versions variance:

• [>= 2] - Variable length encoding for Maps larger than 23 key value pairs, otherwise exact length encoding
• [< 2] - Variable length encoding.

Mimics Map encoder encodeMap identically.

Generic encoder for vectors. Its intended use is to allow easy definition of EncCBOR instances for custom vector

Conditionally use variable length encoding for list like structures with length larger than 23, otherwise use exact list length encoding.

Encode any Foldable with the variable list length encoding, which will use indefinite encoding over 23 elements and definite otherwise.

Encode any Foldable with indefinite list length encoding

Encode a data structure as a Map with the 0-based index for a Key to a value. Uses variable map length encoding, which means an indefinite encoding for maps with over 23 elements and definite otherwise.

This is the optimal maximum number for encoding exact length. Above that threashold using variable length encoding will result in less bytes on the wire.