Documentation

cbor

Reads structured data from a CBOR file.

The file must contain a valid CBOR serialization. Mappings will be converted into Typst dictionaries, and sequences will be converted into Typst arrays. Strings and booleans will be converted into the Typst equivalents, null-values (null, ~ or empty ``) will be converted into none, and numbers will be converted to floats or integers depending on whether they are whole numbers.

Be aware that integers larger than 263-1 will be converted to floating point numbers, which may result in an approximative value.

Parameters
Question mark

cbor() -> any

source
str or bytes
RequiredPositional
Question mark

A path to a CBOR file or raw CBOR bytes.

Definitions
Question mark

decode
Warning
cbor.decode is deprecated, directly pass bytes to cbor instead

Reads structured data from CBOR bytes.

cbor.decode() -> any

data
bytes
RequiredPositional
Question mark

CBOR data.

encode

Encode structured data into CBOR bytes.

cbor.encode(
any
) -> bytes

value
any
RequiredPositional
Question mark

Value to be encoded.